brandmyth / bangla-mpdf
PHP 库,用于从 UTF-8 编码的 HTML 生成 PDF 文件
Requires
- php: ^5.6 || ^7.0 || ~8.0.0 || ~8.1.0 || ~8.2.0
- ext-gd: *
- ext-mbstring: *
- mpdf/psr-log-aware-trait: ^2.0 || ^3.0
- myclabs/deep-copy: ^1.7
- paragonie/random_compat: ^1.4|^2.0|^9.99.99
- psr/http-message: ^1.0
- psr/log: ^1.0 || ^2.0 || ^3.0
- setasign/fpdi: ^2.1
Requires (Dev)
- mockery/mockery: ^1.3.0
- mpdf/qrcode: ^1.1.0
- squizlabs/php_codesniffer: ^3.5.0
- tracy/tracy: ~2.5
- yoast/phpunit-polyfills: ^1.0
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
This package is not auto-updated.
Last update: 2024-09-20 14:01:22 UTC
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 脚本提供写权限。
有关自定义临时目录的更多信息,请参阅《安装与设置》部分中关于临时文件目录的说明。
如果您遇到问题,请阅读《手册》中关于故障排除的部分。
关于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文件都将自动加载。