xzy / dompdf
DOMPDF是一个符合CSS 2.1规范的HTML到PDF转换器
Requires
- php: ^7.1
- ext-dom: *
- ext-mbstring: *
- phenx/php-font-lib: ^0.5.1
- phenx/php-svg-lib: ^0.3.3
Requires (Dev)
- phpunit/phpunit: ^7.5
- squizlabs/php_codesniffer: ^3.5
Suggests
- ext-gd: Needed to process images
- ext-gmagick: Improves image processing performance
- ext-imagick: Improves image processing performance
This package is auto-updated.
Last update: 2024-09-29 05:42:51 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)
- 由于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就会将任何引用的字体嵌入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: http://getcomposer.org/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 对不规范的 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#320 以获取进度
如果您觉得这个项目有用,请考虑捐赠。捐赠的资金将用于帮助进一步开发此项目。)