narutovn/dompdf

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

1.0.3 2020-02-19 02:35 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 版本 5.4.0 或更高
  • 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: http://getcomposer.org/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

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