README

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

它基于 FPDF 和 HTML2FPDF (参见 CREDITS)，并添加了许多增强功能。mPDF 由 Ian Back 编写，并按照 GNU GPL v2 许可发布。

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

要求

PHP 版本和扩展

• PHP >=5.6 <7.3.0 支持 mPDF >= 7.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 8.2 从 mPDF v8.1.3 开始支持

PHP 的 mbstring 和 gd 扩展必须被加载。

对于某些高级功能，可能需要额外的扩展，例如 zlib 用于输出和嵌入资源的压缩（如字体），bcmath 用于生成条形码或 xml 用于字符集转换和 SVG 处理。

已知的服务器问题

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 脚本赋予写权限。

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

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

关于CSS支持和开发状态

mPDF整体来说是一款相当老旧的软件。如今，尽管不是用PHP编写的，但已经有了更好的替代品。

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

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

mPDF仍将进行更新，以增强一些内部功能和支持更新的PHP版本，但更好的或更新的CSS支持可能不会实现。

在线手册

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

一般故障排除

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

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

贡献

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

单元测试

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

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

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

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