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

v7.0.0.2 2017-05-09 20:34 UTC

README

mPDF是一个PHP库,可以将UTF-8编码的HTML转换为PDF文件。

它基于FPDFHTML2FPDF(见CREDITS),并增加了一些功能。mPDF由Ian Back编写,并按照GNU GPL v2许可证发布。

Build Status

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

要求

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

可能还需要一些附加扩展来实现某些高级功能,例如,使用zlib压缩输出和嵌入资源(如字体),使用bcmath生成条形码,或使用xml进行字符集转换和SVG处理。

支持我们

请考虑通过捐赠任何金额来支持mPDF的开发。可以在mPDF文档主页找到捐赠按钮

安装

官方安装方法是通过composer及其Packagist软件包mpdf/mpdf

$ composer require mpdf/mpdf

使用

自7.0版本以来,库的最简单使用方法如下

<?php

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

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

这将输出PDF,作为application/pdf内容类型内嵌到浏览器中。

设置和配置

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

建议通过tempDir配置变量设置自己的临时目录。该目录必须对使用mPDF的用户(通常是cliwebserverfpm)具有写入权限(推荐模式为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 文件都会自动加载。