costalong / dompdf
DOMPDF 是一个符合 CSS 2.1 规范的 HTML 转 PDF 转换器
Requires
- php: >=5.4.0
- ext-dom: *
- ext-mbstring: *
- phenx/php-font-lib: 0.5.*
- phenx/php-svg-lib: 0.3.*
Requires (Dev)
- phpunit/phpunit: ^4.8|^5.5|^6.5
- squizlabs/php_codesniffer: 2.*
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-10 18:29:56 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-wrappers)
- 支持复杂的表格,包括行 & 列跨距、独立的 & 收缩的边框模型、单个单元格样式
- 图像支持(gif、png(8、24 和 32 位带 alpha 通道)、bmp & jpeg)
- 由于 R&OS PDF 类,无需依赖外部 PDF 库
- 内联 PHP 支持
- 基本的 SVG 支持
要求
- PHP 版本 5.4.0 或更高
- DOM 扩展
- GD 扩展
- MBString 扩展
- php-font-lib
- php-svg-lib
建议
- OPcache(OPcache、XCache、APC 等.):提高性能
- 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';
使用git进行安装
在命令行中,切换到dompdf将要存放的目录,并运行以下命令
git clone https://github.com/dompdf/dompdf.git cd dompdf git clone https://github.com/PhenX/php-font-lib.git lib/php-font-lib cd lib/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
在PHP中需要dompdf、库和辅助函数
require_once 'dompdf/lib/html5lib/Parser.php'; require_once 'dompdf/lib/php-font-lib/src/FontLib/Autoloader.php'; require_once 'dompdf/lib/php-svg-lib/src/autoload.php'; require_once 'dompdf/src/Autoloader.php'; Dompdf\Autoloader::register();
快速开始
只需将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(); $dompdf->set_option('defaultFont', 'Courier');
请参阅Dompdf\Options以获取可用选项的列表。
局限性(已知问题)
- Dompdf对格式错误的HTML输入不是很容忍。为了避免任何意外的渲染问题,您应该启用运行时内置的HTML5解析器(
$dompdf->set_option('isHtml5ParserEnabled', true);
)或者将您的HTML通过HTML验证器/清洁器(如Tidy或W3C Markup Validation Service)处理。 - 大文件或大数据表可能需要较长时间渲染。
- CSS float正处于开发中,可能不会产生预期的结果。
如果您觉得这个项目很有用,请考虑捐款。捐赠的资金将用于支持本项目的进一步开发。()