abdallahalyamni / mpdf-arabic
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-26 13:43:13 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
,以及用于字符集转换和 SVG 处理的 xml
。
已知的服务器注意事项
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文件在单元测试时都将被自动加载。