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 包装器)
支持复杂的表格，包括行和列跨越、单独和合并的边框模型、单个单元格样式
图像支持 (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: http://getcomposer.org/doc/00-intro.md
require 'vendor/autoload.php';

下载和安装

下载 dompdf 的打包存档并将其解压到 dompdf 将要存放的目录中

您可以从 https://github.com/dompdf/dompdf/releases 下载 dompdf 的稳定版本
或从 http://eclecticgeek.com/dompdf 下载夜间版（最新、未发布代码）

使用打包发布自动加载器将 dompdf、库和辅助函数加载到您的 PHP 中

// 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 验证服务）运行您的 HTML。
表格单元格不可分页，这意味着表格行必须适合单页。
在解析时渲染活动页面上的元素。
嵌入 "原始" SVG（<svg><path...></svg>）尚未工作，您需要链接到外部 SVG 文件或使用类似以下的数据 URI
```
$html = '<img src="data:image/svg+xml;base64,' . base64_encode($svg) . '" ...>';
```
查看 dompdf#320 以了解进度

如果您觉得这个项目很有用，请考虑捐款。任何捐款都将用于帮助本项目的进一步开发。)

brunodebarros / dompdf

维护者

详细信息