jaredpack / dompdf
内置签名字体的DOMPDF
Requires
- php: ^7.1 || ^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.3
- phpunit/phpunit: ^7.5 || ^8 || ^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
- 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)。
建议
- OPcache(OPcache、XCache、APC等):提高性能
- GD(用于图像处理)
- IMagick或GMagick扩展:提高图像处理性能
访问wiki以获取更多信息: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: http://getcomposer.org/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对从本地文件系统或网络引用的文件施加了限制。
通过基于网络的协议访问的文件有以下要求
- 必须将Dompdf选项"isRemoteEnabled"设置为"true"
- PHP必须启用curl扩展或允许_url_fopen设置设置为true
通过本地文件系统访问的文件有以下要求
- 文件必须位于Dompdf "chroot"选项指定的路径内
限制(已知问题)
- Dompdf对不规范的HTML输入不太宽容。为了避免任何意外的渲染问题,您应该要么在运行时启用内置的HTML5解析器(
$options->setIsHtml5ParserEnabled(true);
),要么通过HTML验证器/清理器(如Tidy或W3C Markup Validation Service)运行您的HTML。 - 表格单元格不可分页,这意味着表行必须适合单页。
- 当元素被解析时,它们被渲染在活动页上。
- 嵌入"原始"SVG(
<svg><path...></svg>
)尚未实现,您需要链接到外部SVG文件,或者使用类似这样的DataURI$html = '<img src="data:image/svg+xml;base64,' . base64_encode($svg) . '" ...>';
关注dompdf/dompdf#320的进展
如果您觉得这个项目有用,请考虑进行捐赠。捐赠的资金将用于帮助进一步开发本项目。)