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

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

v0.8.2 2017-11-26 14:49 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 上提出任何问题。

关注我们 TwitterFollow us on Google+

特性

  • 处理大多数 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 扩展
  • 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字体,以提供良好的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的autoload文件。

// 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将要驻留的目录中

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

// 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验证器/清理器(如TidyW3C Markup Validation Service)运行您的HTML。
  • 大文件或大表格可能需要较长时间才能渲染。
  • CSS浮动功能仍在开发中,可能无法产生期望的结果

Donate button

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