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

v0.7.0 2016-05-11 00:36 UTC

README

Build Status Latest Stable Version Total Downloads Latest Unstable Version License

Dompdf是一个HTML转PDF转换器

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

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

查看演示并在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.3.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将嵌入任何引用的字体,只要它已预先加载或对dompdf是可访问的,并且在CSS @font-face规则中引用。有关如何使用字体的更多信息,请参阅字体概述

已预先安装了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加载的autoload文件已加载。

// 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';

使用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.4
cd ..

git clone https://github.com/PhenX/php-svg-lib.git php-svg-lib
cd php-svg-lib
git checkout v0.1

在PHP中要求dompdf、库和帮助函数

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

快速入门

只需将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

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