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 8.3自mPDF v8.2.1起支持

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脚本来设置写权限。

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

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

关于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文件都将自动加载。