hkvstore / dompdf
DOMPDF 是一个符合 CSS 2.1 标准的 HTML 到 PDF 转换器
Requires
- php: ^7.4 || ^8.0
- ext-dom: *
- ext-mbstring: *
- dompdf/php-font-lib: ^1.0.0
- dompdf/php-svg-lib: ^1.0.0
- masterminds/html5: ^2.0
Requires (Dev)
- ext-gd: *
- ext-json: *
- ext-zip: *
- mockery/mockery: ^1.3
- phpunit/phpunit: ^7.5 || ^8 || ^9 || ^10
- squizlabs/php_codesniffer: ^3.5
- symfony/process: ^4.4 || ^5.4 || ^6.2 || ^7.0
Suggests
- ext-gd: Needed to process images
- ext-gmagick: Improves image processing performance
- ext-imagick: Improves image processing performance
- ext-zlib: Needed for pdf stream compression
README
Dompdf 是一个 HTML 到 PDF 转换器
在核心上,dompdf 是一个(主要)符合 CSS 2.1 的 HTML 布局和渲染引擎,用 PHP 编写。它是一个以样式驱动的渲染器:它会下载和读取外部样式表、内联样式标签以及单个 HTML 元素的样式属性。它还支持大多数表现性 HTML 属性。
本文件适用于最新的稳定代码,可能无法反映当前版本。有关已发布的代码,请 导航到适当的标签。
查看 演示 并在 StackOverflow 或 讨论 中提出任何问题。
特性
- 处理大多数 CSS 2.1 和一些 CSS3 属性,包括 @import、@media 和 @page 规则
- 支持大多数表现性 HTML 4.0 属性
- 支持外部样式表,无论是本地还是通过 http/ftp(通过 fopen-wrappers)
- 支持复杂的表格,包括行和列跨行、分离和折叠的边框模型、单个单元格样式
- 图像支持(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)。
推荐
- GD(用于图像处理)
- 此外,IMagick 或 GMagick 扩展提高了某些图像类型的图像处理性能
- OPcache(OPcache、XCache、APC 等.):提高性能
访问维基获取更多信息:https://github.com/dompdf/dompdf/wiki/Requirements
关于字体和字符编码
PDF 文档内部支持以下字体:Helvetica、Times-Roman、Courier、Zapf-Dingbats 和 Symbol。这些字体仅支持 Windows ANSI 编码。为了使 PDF 显示 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的自动加载文件已被加载。
// 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(); $options = $dompdf->getOptions(); $options->setDefaultFont('Courier'); $dompdf->setOptions($options);
有关可用选项的列表,请参阅Dompdf\Options。
资源引用要求
为了保护可能敏感的信息,Dompdf对从本地文件系统或网络引用的文件施加限制。
通过基于Web的协议访问的文件有以下要求
- Dompdf选项"isRemoteEnabled"必须设置为"true"
- PHP必须启用curl扩展或允许_url_fopen设置设置为true
通过本地文件系统访问的文件有以下要求
- 文件必须在Dompdf"chroot"选项指定的路径中
限制(已知问题)
- 表格单元格不可分页,这意味着表行必须适合单页。
- 当解析元素时,它们将渲染在活动页上。
- 嵌入"原始"SVG(
<svg><path...></svg>
)尚未工作,您需要链接到外部SVG文件或使用如下所示的数据URI$html = '<img src="data:image/svg+xml;base64,' . base64_encode($svg) . '" ...>';
请关注dompdf/dompdf#320的进展 - 不支持CSS flexbox。
- 不支持CSS Grid。
- 单个Dompdf实例不应用于渲染多个HTML文档,因为持久的解析和渲染痕迹可能会影响未来的渲染。
如果您发现这个项目很有用,请考虑捐款。任何捐款都将用于支持本项目的发展。)