artjoker / dompdf
DOMPDF是一个符合CSS 2.1规范的HTML转PDF转换器
Requires
- php: ^7.1 || ^8.0
- ext-dom: *
- ext-mbstring: *
- masterminds/html5: ^2.0
- phenx/php-font-lib: >=0.5.4 <1.0.0
- phenx/php-svg-lib: >=0.3.3 <1.0.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
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 to PDF Converter分支而来
Dompdf是一个HTML转PDF转换器
在核心上,dompdf(主要)是一个使用PHP编写的符合CSS 2.1规范的HTML布局和渲染引擎。它是一个样式驱动的渲染器:它将下载和读取外部样式表、内联样式标签以及单个HTML元素的样式属性。它也支持大多数呈现HTML属性。
本文件适用于最新稳定代码,可能不反映当前版本。有关已发布代码,请导航到相应的标签。
查看示例,并在StackOverflow或讨论区提问。
功能
- 处理大多数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编码。为了使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 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 将驻留的目录中
- 您可以从以下网址下载 dompdf 的稳定版本:https://github.com/dompdf/dompdf/releases
- 或者从以下网址下载每日版本(最新未发布代码):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 扩展或将 allow_url_fopen 设置为 true
通过本地文件系统访问的文件有以下要求
- 文件必须位于 Dompdf "chroot" 选项指定的路径内
限制(已知问题)
- 单元格不可分页,这意味着表行必须适合单页。
- 当解析元素时,它们将在活动页面上渲染。
- 嵌入 "raw" SVG(
<svg><path...></svg>
)尚未工作,您需要链接到外部 SVG 文件或使用类似这样的 DataURI$html = '<img src="data:image/svg+xml;base64,' . base64_encode($svg) . '" ...>';
关注 dompdf/dompdf#320 的进度 - 不支持 CSS flexbox。
- 不支持 CSS Grid。
如果您觉得这个项目有用,请考虑捐款。捐赠的资金将用于支持该项目的进一步开发。)