dompdf/dompdf
GitHub: dompdf/dompdf
一款纯 PHP 实现的 HTML 到 PDF 转换库,支持 CSS 2.1 样式渲染,无需外部依赖即可在服务端生成 PDF 文档。
Stars: 11083 | Forks: 1832
# Dompdf
[](https://github.com/dompdf/dompdf/actions/workflows/test.yml)
[](https://packagist.org/packages/dompdf/dompdf)
[](https://packagist.org/packages/dompdf/dompdf)
[](https://packagist.org/packages/dompdf/dompdf)
[](https://packagist.org/packages/dompdf/dompdf)
**Dompdf 是一个 HTML 转 PDF 的转换器**
Dompdf 的核心是一个(主要)[CSS 2.1](http://www.w3.org/TR/CSS2/) 兼容的 HTML 布局和渲染引擎,使用 PHP 编写。它是一个样式驱动的渲染器:它会下载并读取外部样式表、内联样式标签以及单个 HTML 元素的样式属性。它还支持大多数表现性 HTML 属性。
*本文档适用于最新的稳定代码,可能不反映当前的发布版本。对于已发布的代码,请[导航至相应的标签](https://github.com/dompdf/dompdf/tags)。*
**查看[演示](http://eclecticgeek.com/dompdf/debug.php)并在 [StackOverflow](https://stackoverflow.com/questions/tagged/dompdf) 或 [讨论区](https://github.com/dompdf/dompdf/discussions)提问。**
## 特性
* 处理大多数 CSS 2.1 和少量 CSS3 属性,包括 @import、@media 和 @page 规则
* 支持大多数 HTML 4.0 表现性属性
* 支持外部样式表,无论是本地还是通过 http/ftp(通过 fopen-wrappers)
* 支持复杂的表格,包括行和列的跨度、分离和合并边框模型、单个单元格的样式
* 图像支持(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)。
### 推荐
* GD(用于图像处理)
* 此外,IMagick 或 GMagick 扩展可以提高某些图像类型的图像处理性能
* OPcache(OPcache、XCache、APC 等):提高性能
访问 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 中。有关如何使用字体的更多信息,请参阅[字体概述](https://github.com/dompdf/dompdf/wiki/About-Fonts-and-Character-Encoding)。
[DejaVu TrueType 字体](https://dejavu-fonts.github.io/)已经预安装,以便默认为 dompdf 提供良好的 Unicode 字符覆盖。要使用 DejaVu 字体,请在样式表中引用该字体,例如 `body { font-family: DejaVu Sans; }`(用于 DejaVu Sans)。以下 DejaVu 2.34 字体可用:DejaVu Sans、DejaVu Serif 和 DejaVu Sans Mono。
## 简易安装
### 使用 Composer 安装
要使用 [Composer](https://getcomposer.org/) 安装,只需引入此包的最新版本。
```
composer require dompdf/dompdf
```
确保加载来自 Composer 的 autoload 文件。
```
// 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 下载 nightly 版本(最新的、未发布的代码)
使用打包发布的 autoloader 在您的 PHP 中加载 dompdf、库和辅助函数:
```
// include autoloader
require_once 'dompdf/autoload.inc.php';
```
注意:打包发布的版本使用语义化版本命名(_dompdf_MAJOR-MINOR-PATCH.zip_)。因此,1.0.0 版本将是 dompdf_1-0-0.zip。这是唯一包含 Dompdf 及其所有依赖项 autoloader 的下载。
### 使用 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 项目中的 autoloader](https://github.com/dompdf/utils/blob/master/autoload.inc.php)。
## 框架集成
* 对于 Symfony:[nucleos/dompdf-bundle](https://github.com/nucleos/NucleosDompdfBundle)
* 对于 Laravel:[barryvdh/laravel-dompdf](https://github.com/barryvdh/laravel-dompdf)
* 对于 Redaxo:[PdfOut](https://github.com/FriendsOfREDAXO/pdfout)
## 快速入门
只需将您的 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](src/Options.php)。
### 资源引用要求
为了保护潜在的敏感信息,Dompdf 对从本地文件系统或 Web 引用的文件施加了限制。
通过基于 Web 的协议访问的文件具有以下要求:
* Dompdf 选项 "isRemoteEnabled" 必须设置为 "true"
* PHP 必须启用 curl 扩展,或将 allow_url_fopen 设置设置为 true
通过本地文件系统访问的文件具有以下要求:
* 文件必须位于为 Dompdf "chroot" 选项指定的路径内
## 限制(已知问题)
* 表格单元格不可分页,这意味着一个表格行必须适合单个页面:见 https://github.com/dompdf/dompdf/issues/98
* 元素在解析时呈现在活动页面上。
* 嵌入“原始”SVG(``)尚不可用:见 https://github.com/dompdf/dompdf/issues/320
解决方法:链接到外部 SVG 文件,或使用 DataURI,如下所示:
$html = '
';
* 不支持 CSS flexbox:见 https://github.com/dompdf/dompdf/issues/971
* 不支持 CSS Grid:见 https://github.com/dompdf/dompdf/issues/2988
* 单个 Dompdf 实例不应用于渲染多个 HTML 文档,因为持久化的解析和渲染残留可能会影响未来的渲染。
[](http://goo.gl/DSvWf)
*如果您觉得这个项目有用,请考虑捐款。捐赠的任何资金将用于帮助该项目的进一步开发。)*
标签:Composer包, CSS渲染, Dompdf, ffuf, HTML渲染引擎, HTML转PDF, OpenVAS, PDF转换器, PHP, PHP扩展, SVG支持, Syscall, Web开发, 后端开发, 开源库, 报表生成, 搜索引擎爬虫, 文件处理, 文档生成, 无外部依赖