strangetin/dompdf

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

此包的官方仓库似乎已不存在,因此该包已被冻结。

v0.8.9 2020-12-18 06:32 UTC

README

Build Status Latest Stable Version Total Downloads Latest Unstable Version License

Dompdf 是一个 HTML 到 PDF 转换器

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

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

查看示例,并在 StackOverflowGoogle Groups 上提问。

关注我们的 Twitter

功能

  • 处理大多数 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: https://getcomposer.org.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();
$options = $dompdf->getOptions();
$options->setDefaultFont('Courier');
$dompdf->setOptions($options);

有关可用选项的列表,请参阅Dompdf\Options

限制(已知问题)

  • Dompdf对格式不正确的HTML输入不太宽容。为了避免任何意外的渲染问题,您应启用运行时内置的HTML5解析器($options->setIsHtml5ParserEnabled(true);)或通过HTML验证器/清理器(如TidyW3C标记验证服务)运行您的HTML。
  • 表单元格不可分页,这意味着表行必须适合单页。
  • 元素在解析时渲染在活动页上。
  • 嵌入 "raw" SVG(例如:<svg><path...></svg>)目前还未实现,您需要链接到外部 SVG 文件,或者使用类似这样的 DataURI
    $html = '<img src="data:image/svg+xml;base64,' . base64_encode($svg) . '" ...>';
    请关注 https://github.com/dompdf/dompdf/issues/320 以获取进展信息

Donate button

如果您觉得这个项目很有用,请考虑捐款。所有捐赠的资金都将用于进一步开发该项目。