一个PHP类,用于从HTML生成支持Unicode/UTF-8和CJK的PDF文件

v7.2.1 2017-10-10 15:24 UTC

README

mPDF是一个PHP类,它可以从UTF-8编码的HTML生成PDF文件。它基于FPDFHTML2FPDF(见CREDITS),增加了一些功能。mPDF由Ian Back编写,并按照GNU GPL v2许可证发布。

Build Status

注意:如果您在mPDF的GitHub仓库主页上查看此文件,请注意默认仓库分支是development,这可能与最新稳定版本不同。

要求

mPDF 7.0需要PHP ^5.6 || ~7.0.0。必须加载PHP的mbstringgd扩展。

PHP ~7.1.0 应该兼容。

某些高级功能(如用于压缩嵌入资源(如字体)的zlib或用于生成条码的bcmath)可能需要其他扩展。

安装

官方安装方法是通过composer及其packagist包mpdf/mpdf

$ composer require mpdf/mpdf

用法

库的最简单用法如下

<?php

require_once __DIR__ . '/vendor/autoload.php';

$mpdf = new \Mpdf\Mpdf();
$mpdf->WriteHTML('<h1>Hello world!</h1>');
$mpdf->Output();

这将将HTML内联输出到浏览器。

设置与配置

可以通过构造函数的$config参数设置所有配置指令

建议通过tempDirfontTempDir配置变量设置自己的临时目录。目录必须具有写入权限(推荐模式775)。

<?php

$mpdf = new \Mpdf\Mpdf(['tempDir' => __DIR__ . '/tmp']);

默认情况下,临时目录将位于vendor目录内,并且将从post_install composer脚本中具有正确的权限。

有关自定义临时目录的更多信息,请参阅Folder for temporary files部分中的说明,该部分位于手册的安装和设置部分。

如果您遇到问题,请参阅手册中的故障排除部分。

在线手册

在线手册可在https://mpdf.github.io/找到。

贡献

请参阅项目中的CONTRIBUTING.md文件。

单元测试

mPDF的单元测试使用PHPUnit进行。

要从命令行开始,请在mPDF根目录中运行composer install(您首先需要安装composer)。

要从命令行执行测试,请在mPDF根目录中运行vendor/bin/phpunit

非常感谢您为mPDF编写单元测试的协助。如果您愿意帮忙,请注意,在单元测试时,位于/tests/目录下的任何PHP文件都将自动加载。