sfneal / dompdf
Requires
- php: ^7.3 || ^8.0
- ext-dom: *
- ext-mbstring: *
- phenx/php-font-lib: ^0.5.2
- phenx/php-svg-lib: ^0.3.3
Requires (Dev)
- mockery/mockery: >=1.4
- phpunit/phpunit: ^9
- squizlabs/php_codesniffer: ^3.5
Suggests
- ext-gd: Needed to process images
- ext-gmagick: Improves image processing performance
- ext-imagick: Improves image processing performance
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)
- 不依赖于外部 PDF 库,归功于 R&OS 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/sfneal/dompdf/wiki/Requirements
关于字体和字符编码
PDF 文档内部支持以下字体:Helvetica、Times-Roman、Courier、Zapf-Dingbats 和 Symbol。这些字体仅支持 Windows ANSI 编码。为了使 PDF 能够显示 Windows ANSI 中不可用的字符,您必须提供外部字体。只要字体已经预先加载或可供 dompdf 访问并在 CSS @font-face 规则中引用,Dompdf 就会将任何引用的字体嵌入 PDF 中。有关如何使用字体的更多信息,请参阅字体概述。
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 sfneal/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/sfneal/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/sfneal/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 对从本地文件系统或网络引用的文件施加限制。
通过基于网络的协议访问的文件有以下要求
- Dompdf 选项 "isRemoteEnabled" 必须设置为 "true"
- PHP 必须启用 curl 扩展或允许_url_fopen 设置为 true
通过本地文件系统访问的文件有以下要求
- 该文件必须位于 Dompdf "chroot" 选项指定的路径之一中
限制(已知问题)
- Dompdf 对格式不良的 HTML 输入不太容忍。为了避免任何意外的渲染问题,您应该启用内置的 HTML5 解析器(
$options->setIsHtml5ParserEnabled(true);
)或将您的 HTML 通过 HTML 验证器/清理器(例如 Tidy 或 W3C 标记验证服务)。 - 表格单元格不可分页,意味着表格行必须完整地位于单页上。
- 当元素被解析时,它们将在活动页面上渲染。
- 嵌入“原始”SVG(
<svg><path...></svg>
)目前不起作用,您需要链接到外部SVG文件,或者使用类似这样的DataURI$html = '<img src="data:image/svg+xml;base64,' . base64_encode($svg) . '" ...>';
请关注https://github.com/sfneal/dompdf/issues/320以了解进展
如果您觉得这个项目有用,请考虑捐款。任何捐赠的资金都将用于支持本项目的进一步开发。)