README

mPDF是一个PHP库，可以从UTF-8编码的HTML生成PDF文件。

它基于FPDF和HTML2FPDF（见CREDITS），并添加了一些增强功能。mPDF由Ian Back编写，并使用GNU GPL v2许可证发布。

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

要求

PHP版本和扩展

• mPDF >=7.0支持在PHP ^5.6 || ~7.0.0 || ~7.1.0 || ~7.2.0
• PHP 7.3从mPDF v7.1.7开始支持
• PHP 7.4从mPDF v8.0.4开始支持
• PHP 8.0从mPDF v8.0.10开始支持
• PHP 8.1从mPDF v8.0.13开始支持

PHP mbstring和gd扩展必须加载。

对于一些高级功能，可能需要额外的扩展，例如用于输出和嵌入资源的压缩以及字体等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();

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

设置与配置

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

建议通过tempDir配置变量设置自己的临时目录。该目录必须对使用mPDF的用户具有写权限（推荐模式为775）。

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

<?php

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

默认情况下，临时目录将位于vendor目录内，并由post_install composer脚本赋予写权限。

有关自定义临时目录的更多信息，请参阅《安装与设置》部分中关于临时文件目录的说明。

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

关于CSS支持和开发状态

mPDF作为整体软件相对较旧。如今，尽管不是用PHP编写的，但仍有更好的替代品。

如果无法使用非PHP方法生成PDF文件，或者想要利用mPDF相对于浏览器方法的一些优点（如颜色处理、预打印、条码支持、页眉页脚、页码、目录等），则可以使用mPDF。但请注意，可能需要针对mPDF定制的HTML/CSS模板。

如果您正在寻找最先进的CSS支持，需要将现有HTML页面镜像到PDF中，请使用无头Chrome。

mPDF将继续更新以增强某些内部功能并支持更新的PHP版本，但更优或更新的CSS支持可能不会实现。

在线手册

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

一般故障排除

对于一般问题或故障排除，请使用讨论区。

您还可以在Stack Overflow上使用mpdf标签，因为StackOverflow的用户更有可能及时回答您的问题。

贡献

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

单元测试

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

要从命令行开始，请在mPDF根目录中运行composer install（您需要先安装composer）。

要执行测试，请在mPDF根目录中从命令行运行composer test。

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