tekintian/dompdf

默认支持中文的dompdf,HTML转PDF工具类,DOMPDF是一个符合CSS 2.1的HTML到PDF转换器

v2.0.4 2023-10-07 11:36 UTC

README

本项目为Dompdf的默认中文支持版本。

官方默认不支持中文,要支持中文需要一堆的设置,太过麻烦,所以直接适配了这个默认支持中文的版本。

加载后默认支持中文,不需要任何配置。

默认中文字体: hyqh 汉仪旗黑,大小为 2.1M

使用示例

安装依赖

composer require tekintian/dompdf
  • 默认使用中文字体
use Dompdf\Dompdf;

 //初始化Dompdf对象
$dompdf = new Dompdf();

//创建HTML内容 
$html = '<h1 style="font-size:5rem;color:blue;">你好Dompdf!</h1><h2>我默认使用的是中文字体</h2>';
$dompdf->loadHtml($html);

$dompdf->loadHtml($html);

//Setup the paper size and orientation
// $dompdf->setPaper('A4', 'landscape');

//将html转为PDF
$dompdf->render();

//Output the generated PDF to Browser
$pdfname = '你好PDF.pdf';

//下载生成的pdf文件
//$dompdf->stream($pdfname);

//将生成的pdf保存到服务器
file_put_contents($pdfname, $dompdf->output());

//将生成的pdf文件渲染到页面
// $dompdf->stream($pdfname, [
//     'compress' => 0,
//     'Attachment' => 0
// ]);

自行添加其他中文字体

# 将 load_font.php 拷贝到项目根目录(和vendor同级目录)
cp vendor/tekintian/dompdf/load_font.php ./

# 安装字体到库中
php ./load_font.php "字体名称" "字体路径.ttf"

使用中文字体

在需要进行pdf转换的HTML中使用中文字体的方式与普通的HTML相同,可以是内联样式,也可以使用在style标签中。

<body style="font-family:hyqh">手动指定中文字体</body>

技术交流QQ:932256355

Dompdf是一个HTML到PDF转换器

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

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

查看演示,并在StackOverflow讨论中提出任何问题。

Twitter上关注我们。

功能

  • 处理大多数CSS 2.1和少量CSS3属性,包括@import、@media和@page规则
  • 支持大多数表现性HTML 4.0属性
  • 支持外部样式表,本地或通过http/ftp(通过fopen包装器)
  • 支持复杂的表格,包括行和列跨度、独立的和折叠的边框模型、单个单元格样式
  • 图像支持(gif、png(8、24和32位带透明通道)、bmp和jpeg)
  • 不依赖于外部PDF库,多亏了R&OS 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扩展:提高图像处理性能

访问维基以获取更多信息: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 对来自本地文件系统或网络的文件引用施加了限制。

通过基于 Web 的协议访问的文件有以下要求

  • Dompdf 选项 "isRemoteEnabled" 必须设置为 "true"
  • PHP 必须启用 curl 扩展或将 allow_url_fopen 设置为 true

通过本地文件系统访问的文件有以下要求

  • 文件必须位于 Dompdf "chroot" 选项指定的路径内

限制(已知问题)

  • 单元格不可分页,这意味着表格行必须适合单页。
  • 在解析时渲染活动页面上的元素。
  • 嵌入 "raw" SVG(<svg><path...></svg>)尚未工作,您需要链接到外部 SVG 文件或使用类似此的 DataURI
    $html = '<img src="data:image/svg+xml;base64,' . base64_encode($svg) . '" ...>';
    请关注 dompdf/dompdf#320 的进展
  • 不支持 CSS Flexbox。
  • 不支持 CSS Grid。

Donate button

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