vv_guo/dompdf

DOMPDF 是一个符合 CSS 2.1 规范的 HTML 到 PDF 转换器

v3.0.2 2024-08-07 05:59 UTC

README

Build Status Latest Release Total Downloads License

Dompdf 是一个 HTML 到 PDF 转换器

在核心上,dompdf 是(主要是)一个用 PHP 编写的符合 CSS 2.1 规范的 HTML 布局和渲染引擎。它是一个基于样式的渲染器:它会下载并读取外部样式表、内联样式标签以及单个 HTML 元素的样式属性。它还支持大多数表现性 HTML 属性。

本文件适用于最新稳定代码,可能不反映当前版本。有关发布代码,请导航到相应的标签

查看演示,并在 StackOverflow讨论 中提出任何问题。

关注我们的Twitter

功能

  • 处理大多数 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 版本 7.1 或更高
  • DOM 扩展
  • MBString 扩展
  • php-font-lib
  • php-svg-lib

注意,一些必需的依赖项可能有进一步的依赖项(尤其是 php-svg-lib 需要 sabberworm/php-css-parser)。

推荐

  • GD(用于图像处理)
    • 此外,IMagick 或 GMagick 扩展提高了某些图像类型的图像处理性能
  • OPcache(OPcache、XCache、APC 等.):提高性能

有关更多信息,请访问维基: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将驻留的目录中

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

// include autoloader
require_once 'dompdf/autoload.inc.php';

注意:打包发布按照语义版本命名(_dompdfMAJOR-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对从本地文件系统或网络引用的文件施加限制。

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

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

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

  • 文件必须在Dompdf "chroot"选项指定的路径内

限制(已知问题)

  • 单元格不可分页,这意味着表行必须适合单页。
  • 元素在解析时渲染到活动页上。
  • 嵌入"raw" SVG(<svg><path...></svg>)尚未工作,您需要链接到外部SVG文件或使用类似以下的数据URI
      $html = '<img src="data:image/svg+xml;base64,' . base64_encode($svg) . '" ...>';
    

    请关注https://github.com/dompdf/dompdf/issues/320以获取进展

  • 不支持CSS flexbox。
  • 不支持CSS Grid。
  • 单个Dompdf实例不应用于渲染多个HTML文档,因为持续的解析和渲染碎片可能会影响未来的渲染。

Donate button

如果您觉得这个项目有用,请考虑捐赠。任何捐赠的资金都将用于支持本项目的进一步开发。)