amr.hosney / dompdf
DOMPDF是一个遵循CSS 2.1规范的HTML到PDF转换器
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
This package is not auto-updated.
Last update: 2024-09-25 02:16:25 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)
- 不依赖于外部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扩展:提高图像处理性能
访问wiki以获取更多信息:https://github.com/dompdf/dompdf/wiki/Requirements
关于字体和字符编码
PDF文档内部支持以下字体:Helvetica、Times-Roman、Courier、Zapf-Dingbats和Symbol。这些字体仅支持Windows ANSI编码。为了显示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 将驻留的目录中
- 您可以从 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 通过 HTML 验证器/清理器(如 Tidy 或 W3C 标记验证服务)运行。 - 表格单元格不可分页,这意味着表格行必须适合单页。
- 元素在解析时渲染到活动页面上。
- 嵌入 "raw" SVG(
<svg><path...></svg>
)尚不可用,您需要链接到外部 SVG 文件,或使用类似于此的数据 URI$html = '<img src="data:image/svg+xml;base64,' . base64_encode($svg) . '" ...>';
关注 dompdf#320 的进度
如果您认为此项目有用,请考虑捐款。捐赠的资金将用于进一步开发此项目。)