farhan / dompdf
DOMPDF 是一个 CSS 2.1 兼容的 HTML 转 PDF 转换器
Requires
- php: ^7.1 || ^8.0
- ext-dom: *
- ext-mbstring: *
- phenx/php-font-lib: ^0.5.4
- phenx/php-svg-lib: ^0.3.3 || ^0.4.0
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 auto-updated.
Last update: 2024-09-09 03:54:50 UTC
README
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 扩展:提高图像处理性能
访问 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 就会嵌入任何引用的字体。有关如何使用字体的更多信息,请参阅字体概述。
已预安装 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"选项指定的路径内
限制(已知问题)
- Dompdf对格式错误的HTML输入不太容忍。为了避免任何意外的渲染问题,您应该要么在运行时启用内置的HTML5解析器(
$options->setIsHtml5ParserEnabled(true);
),要么通过HTML验证器/清洁器(如Tidy或W3C标记验证服务)运行您的HTML。 - 表格单元格不可分页,这意味着表格行必须适合单页。
- 元素在解析时渲染到活动页上。
- 嵌入"原始"SVG(
<svg><path...></svg>
)尚未工作,您需要链接到外部SVG文件,或使用类似这样的DataURI$html = '<img src="data:image/svg+xml;base64,' . base64_encode($svg) . '" ...>';
关注dompdf/dompdf#320以获取进度
如果您觉得这个项目很有用,请考虑捐赠。捐赠的资金将用于帮助该项目进一步开发。()