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 在使用单线程服务器的 HTTP 资源获取方面存在一些问题，例如 php -S。建议使用 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文件在单元测试时都将自动加载。