myhayo/dompdf
DOMPDF 是一个符合 CSS 2.1 规范的 HTML 转 PDF 转换器
Requires
- php: ^7.1
- ext-dom: *
- ext-mbstring: *
- phenx/php-font-lib: ^0.5.1
- phenx/php-svg-lib: ^0.3.3
Requires (Dev)
- phpunit/phpunit: ^7.5
- squizlabs/php_codesniffer: ^3.5
Suggests
- ext-gd: Needed to process images
- ext-gmagick: Improves image processing performance
- ext-imagick: Improves image processing performance
This package is auto-updated.
Last update: 2024-09-23 10:11:24 UTC
README
Dompdf 是一个 HTML 转 PDF 转换器
dompdf 的核心是(主要)一个符合 CSS 2.1 的 HTML 布局和渲染引擎,使用 PHP 编写。它是一个以样式驱动的渲染器:它会下载并读取外部样式表、内联样式标签和单个 HTML 元素样式属性。它还支持大多数表现性 HTML 属性。
本文件适用于最新稳定代码,可能无法反映当前版本。对于已发布的代码,请 导航到相应的标签。
查看 示例 并在 StackOverflow 或 Google Groups 上提出任何问题。
特性
- 处理大多数 CSS 2.1 和一些 CSS3 属性,包括 @import、@media 和 @page 规则
- 支持大多数表现性 HTML 4.0 属性
- 支持外部样式表,本地或通过 http/ftp(通过 fopen 包装器)
- 支持复杂的表格,包括行和列跨、独立和折叠的边框模型、单个单元格样式
- 图像支持(gif、png(8、24 和 32 位,带 alpha 通道)、bmp 和 jpeg)
- 由于 R&OS PDF 类,无需外部 PDF 库的依赖
- 内联 PHP 支持
- 基本的 SVG 支持
需求
- PHP 版本 7.1 或更高
- DOM 扩展
- MBString 扩展
- php-font-lib
- php-svg-lib
请注意,一些必需的依赖项可能有进一步的依赖项(特别是 php-svg-lib 需要 sabberworm/php-css-parser)。
建议
- OPcache(OPcache、XCache、APC 等.):提高性能
- GD(用于图像处理)
- IMagick 或 GMagick 扩展:提高图像处理性能
访问维基以获取更多信息: https://github.com/dompdf/dompdf/wiki/Requirements
关于字体和字符编码
PDF 文档内部支持以下字体:Helvetica、Times-Roman、Courier、Zapf-Dingbats 和 Symbol。这些字体仅支持 Windows ANSI 编码。为了显示 Windows ANSI 编码中不可用的字符,您必须提供外部字体。只要已预加载或在 dompdf 中可访问并引用 CSS @font-face 规则,dompdf 就会嵌入任何引用的字体。有关如何使用字体的更多信息,请参阅 字体概述。
DejaVu TrueType字体已预安装,以便dompdf默认情况下提供良好的Unicode字符覆盖。要使用DejaVu字体,请将字体引用到您的样式表中,例如:body { font-family: DejaVu Sans; }
(用于DejaVu Sans)。以下DejaVu 2.34字体可用:DejaVu Sans,DejaVu Serif和DejaVu Sans Mono。
简易安装
使用Composer安装
要使用Composer安装,只需要求此包的最新版本。
composer require dompdf/dompdf
确保加载了Composer的autoload文件。
// somewhere early in your project's loading, require the Composer autoloader // see: https://getcomposer.org.cn/doc/00-intro.md require 'vendor/autoload.php';
下载并安装
下载dompdf的打包归档并解压到dompdf将驻留的目录
- 您可以从https://github.com/dompdf/dompdf/releases下载dompdf的稳定版本。
- 或从http://eclecticgeek.com/dompdf下载夜间版(最新、未发布的代码)
使用打包发布版自动加载器在PHP中加载dompdf、库和辅助函数
// include autoloader require_once 'dompdf/autoload.inc.php';
注意:打包发布版使用语义版本命名(dompdf_MAJOR-MINOR-PATCH.zip)。因此,1.0.0版本发布为dompdf_1-0-0.zip。这是唯一包含Dompdf及其所有依赖项自动加载器的下载。
使用git安装
在命令行中,切换到dompdf将驻留的目录并运行以下命令
git clone https://github.com/dompdf/dompdf.git cd dompdf/lib git clone https://github.com/PhenX/php-font-lib.git php-font-lib cd php-font-lib git checkout 0.5.1 cd .. git clone https://github.com/PhenX/php-svg-lib.git php-svg-lib cd php-svg-lib git checkout v0.3.2 cd .. git clone https://github.com/sabberworm/PHP-CSS-Parser.git php-css-parser cd php-css-parser git checkout 8.1.0
在PHP中要求dompdf及其依赖项。有关详细信息,请参阅utils项目中的自动加载器。
快速入门
只需将HTML传递给dompdf,并输出流
// reference the Dompdf namespace use Dompdf\Dompdf; // instantiate and use the dompdf class $dompdf = new Dompdf(); $dompdf->loadHtml('hello world'); // (Optional) Setup the paper size and orientation $dompdf->setPaper('A4', 'landscape'); // Render the HTML as PDF $dompdf->render(); // Output the generated PDF to Browser $dompdf->stream();
设置选项
在dompdf实例化时设置选项
use Dompdf\Dompdf; use Dompdf\Options; $options = new Options(); $options->set('defaultFont', 'Courier'); $dompdf = new Dompdf($options);
或运行时
use Dompdf\Dompdf; $dompdf = new Dompdf(); $dompdf->set_option('defaultFont', 'Courier');
有关可用选项的列表,请参阅Dompdf\Options。
局限性(已知问题)
- Dompdf对HTML输入的容忍度不高。为了避免任何意外的渲染问题,您应该启用内置的HTML5解析器(在运行时
$dompdf->set_option('isHtml5ParserEnabled', true);
)或通过HTML验证器/清理器(如Tidy或W3C Markup Validation Service)运行您的HTML)。 - 表格单元格不可分页,这意味着表格行必须适合单页。
- 元素在解析时渲染在活动页上。
如果您觉得这个项目很有用,请考虑捐款。任何捐款都将用于帮助本项目进一步发展。)