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

1.0.2 2021-02-02 20:54 UTC

This package is auto-updated.

Last update: 2024-09-05 00:25:22 UTC


README

Build Status Latest Stable Version Total Downloads Latest Unstable Version License

Dompdf 是一个 HTML 到 PDF 转换器

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

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

查看演示,并在 StackOverflowGoogle Groups 上提出任何问题。

关注我们 Twitter

功能

  • 处理大多数 CSS 2.1 和一些 CSS3 属性,包括 @import、@media 和 @page 规则
  • 支持大多数表现性 HTML 4.0 属性
  • 支持外部样式表,无论是本地还是通过 http/ftp(通过 fopen-wrappers)
  • 支持复杂表格,包括行和列跨、分离和合并边框模型、单个单元格样式
  • 图像支持(gif、png(8、24 和 32 位带透明通道)、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 就会嵌入任何引用的字体。有关如何使用字体的更多信息,请参阅字体概述

已预安装了 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://composer.php.ac.cn/doc/00-intro.md
require 'vendor/autoload.php';

下载和安装

下载dompdf的打包压缩文件并将其提取到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();
$dompdf->set_option('defaultFont', 'Courier');

查看Dompdf\Options以获取可用选项列表。

限制(已知问题)

  • Dompdf对不规范的HTML输入不太容忍。为了避免任何意外的渲染问题,您应该要么在运行时启用内置的HTML5解析器($dompdf->set_option('isHtml5ParserEnabled', true);),要么通过HTML验证器/清理器(如TidyW3C标记验证服务)运行您的HTML。
  • 表格单元格不可分页,这意味着表格行必须适合单页。
  • 元素在解析时渲染到活动页上。

Donate button

如果您觉得这个项目有用,请考虑捐款。所有捐款都将用于帮助本项目进一步开发。)