aha / 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-18 10:53:35 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 扩展:提高图像处理性能
有关更多信息,请访问维基: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: 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';
使用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验证器/清理器(如Tidy或W3C标记验证服务)运行您的HTML。 - 大文件或大表格可能需要一段时间才能渲染。
- CSS浮动仍在开发中,可能无法产生预期结果
如果您觉得这个项目很有用,请考虑进行捐赠。所捐赠的资金将用于进一步开发此项目。)