PHP库,用于从UTF-8编码的HTML生成PDF文件

v8.0.7.1 2020-09-17 06:23 UTC

README

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

它基于FPDFHTML2FPDF(见CREDITS),增加了一些功能。mPDF由Ian Back编写,并按照GNU GPL v2许可证发布。

Latest Stable Version Build Status Total Downloads License

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

要求

PHP版本和扩展

  • mPDF >=7.0支持PHP ^5.6 || ~7.0.0 || ~7.1.0 || ~7.2.0
  • PHP 7.3mPDF v7.1.7支持
  • PHP 7.4mPDF v8.0.4支持

PHP mbstringgd扩展必须加载。

可能需要额外的扩展来实现一些高级功能,例如zlib用于输出和嵌入资源的压缩(如字体),bcmath用于生成条形码,以及xml用于字符集转换和SVG处理。

已知的服务器问题

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

支持我们

请考虑通过捐赠任何金额来支持mPDF的开发。捐赠按钮可以在文档主页找到。

安装

官方安装方法是通过composer及其packagist包florentinvintila/mpdf

$ composer require florentinvintila/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部分中的说明,该部分在手册的安装与设置部分。

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

在线手册

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

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

贡献

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

单元测试

mPDF的单元测试使用PHPUnit完成。

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

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

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