tymo49/mpdf

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

7.1.5 2018-06-06 10:04 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 || ~7.2.0。必须加载PHP mbstringgd扩展。

可能还需要额外的扩展,以支持某些高级功能,例如用于输出和嵌入资源的压缩(如字体)的zlib,用于生成条码的bcmath,或用于字符集转换和SVG处理的xml

mPDF在单线程服务器(如php -S)获取外部HTTP资源时存在一些问题。建议使用nginx(php-fpm)或Apache等适当的服务器。

支持我们

请考虑通过任何金额的捐赠来支持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的用户有写权限(推荐模式为775)。

警告: mPDF将在临时目录中清理旧临时文件。请选择仅用于mPDF的专用路径。

<?php

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

默认情况下,临时目录将位于vendor目录内,并由post_install composer脚本来设置正确的权限。

有关自定义临时目录的更多信息,请参阅临时文件文件夹部分中的说明。

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

在线手册

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

对于一般性问题或故障排除,请使用 Stack Overflow 上的 mpdf 标签(而不是项目的 issue 跟踪器)。

贡献

在提交问题或拉取请求之前,请阅读 CONTRIBUTING.md 文件。

单元测试

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

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

要执行测试,请在 mPDF 根目录下通过命令行运行 vendor/bin/phpunit

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