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）。

关于字体和字符编码

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: 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 项目中的自动加载器。

框架集成

对于 Symfony： nucleos/dompdf-bundle
对于 Laravel： barryvdh/laravel-dompdf
对于 Redaxo： 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。

资源引用要求

为了保护可能敏感的信息，Dompdf 对从本地文件系统或网络引用的文件施加限制。

通过基于网络的协议访问的文件有以下要求

Dompdf 选项 "isRemoteEnabled" 必须设置为 "true"
PHP 必须启用 curl 扩展或将 allow_url_fopen 设置为 true

通过本地文件系统访问的文件有以下要求

文件必须位于 Dompdf "chroot" 选项指定的路径内

限制（已知问题）

表格单元格不可分页，这意味着表行必须适合单页。
元素在解析时渲染到活动页面上。
嵌入 "raw" SVG（<svg><path...></svg>）尚未工作，您需要链接到外部 SVG 文件或使用类似此的 DataURI
```
$html = '<img src="data:image/svg+xml;base64,' . base64_encode($svg) . '" ...>';
```
查看 #320 了解进度
不支持 CSS flexbox。
不支持 CSS Grid。
单个 Dompdf 实例不应用于渲染多个 HTML 文档，因为持续的解析和渲染会话可能会影响未来的渲染。

如果您发现此项目有用，请考虑捐款。所有捐款将用于帮助进一步开发此项目。)

dompdf / dompdf

维护者

详细信息