romankobrin / mpdf_lr8
PHP库,用于从UTF-8编码的HTML生成PDF文件
Requires
- php: ^5.6 || ^7.0 || ~8.0.0 || ~8.1.0
- ext-gd: *
- ext-mbstring: *
- myclabs/deep-copy: ^1.7
- paragonie/random_compat: ^1.4|^2.0|9.99.99|9.99.100
- psr/log: ^1.0 || ^2.0
- setasign/fpdi: dev-master
Requires (Dev)
- mockery/mockery: ^0.9.5
- mpdf/qrcode: ^1.0.0
- phpunit/phpunit: ^5.0
- squizlabs/php_codesniffer: ^2.7.0
- tracy/tracy: ^2.4
Suggests
- ext-bcmath: Needed for generation of some types of barcodes
- ext-xml: Needed mainly for SVG manipulation
- ext-zlib: Needed for compression of embedded resources, such as fonts
README
mPDF是一个PHP库,可以从UTF-8编码的HTML生成PDF文件。
它基于FPDF和HTML2FPDF(见CREDITS),增加了许多功能。mPDF由Ian Back编写,并按照GNU GPL v2许可发布。
注意:如果您正在通过mPDF GitHub存储库主页或Packagist查看此文件,请注意,默认存储库分支是
development
,可能不同于最新稳定版本。
要求
mPDF 7+需要PHP ^5.6 || ~7.0.0 || ~7.1.0 || ~7.2.0 || ~7.3.0
。必须加载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部分中的说明。
如果您遇到问题,请参阅手册中的故障排除部分。
在线手册
在线手册可在https://mpdf.github.io/找到。
对于一般性问题或故障排除,请使用 Stack Overflow 上的 mpdf 标签(而不是项目的 Issue Tracker)。
贡献
在提交问题和拉取请求之前,请阅读 CONTRIBUTING.md 文件。
单元测试
mPDF 的单元测试使用 PHPUnit 完成。
要开始,请在 mPDF 根目录下从命令行运行 composer install
(您首先需要安装 composer)。
要执行测试,请在 mPDF 根目录下从命令行运行 vendor/bin/phpunit
。
对于编写 mPDF 单元测试的任何帮助都深受欢迎。如果您想帮忙,请注意,在单元测试期间,位于 /tests/
目录中的任何 PHP 文件都将自动加载。