FPDI 是一组 PHP 类,它使开发者能够从现有的 PDF 文档中读取页面,并将它们用作 FPDF 中的模板。由于 FPDI 也可以与 TCPDF 一起使用,因此没有定义任何固定依赖项。请参阅评估依赖项的包的建议。
Requires
- php: ^5.6 || ^7.0 || ^8.0
- ext-zlib: *
Requires (Dev)
- phpunit/phpunit: ~5.7
- setasign/fpdf: ~1.8.6
- setasign/tfpdf: ~1.33
- squizlabs/php_codesniffer: ^3.5
- tecnickcom/tcpdf: ~6.2
Conflicts
- setasign/tfpdf: <1.31
This package is auto-updated.
Last update: 2024-10-03 14:14:55 UTC
README
❗ 本文档指 FPDI 2 版本。版本 1 已弃用且开发已停止。❗
FPDI 是一组 PHP 类,它使开发者能够从现有的 PDF 文档中读取页面,并将它们用作由 Olivier Plathey 开发的 FPDF 中的模板。除了包含 FPDF 的副本外,FPDI 不需要任何特殊的 PHP 扩展。
使用 Composer 安装
由于 FPDI 可以与 FPDF、TCPDF 或 tFPDF 一起使用,我们未在主 composer.json 文件中添加固定依赖项。您需要自己将依赖项添加到您选择的 PDF 生成库中。
要使用 FPDF 与 FPDI 一起使用,请在您的 composer.json 文件中包含以下内容
{ "require": { "mailstreetdevelopment/fpdi": "dev-master", } }
如果您想使用 TCPDF,您必须更新您的 composer.json 为以下内容
{ "require": { "tecnickcom/tcpdf": "6.6.*", "setasign/fpdi": "^2.5" } }
如果您想使用 tFPDF,您必须更新您的 composer.json 为以下内容
{ "require": { "setasign/tfpdf": "1.33.*", "setasign/fpdi": "^2.3" } }
手动安装
如果您不使用 composer,只需在 /src 文件夹中要求 autoload.php 即可
require_once('src/autoload.php');
如果您实现了 PSR-4 自动加载器,只需按以下方式注册 src 路径
$loader = new \Example\Psr4AutoloaderClass; $loader->register(); $loader->addNamespace('setasign\Fpdi', 'path/to/src/');
版本 1 的更改
版本 2 是 FPDI 的从头开始的重写,它带来了以下内容
- 命名空间代码
- 干净且最新的代码库和样式
- PSR-4 兼容的自动加载
- 性能提升高达 100%
- 更低的内存消耗
- 从字符串或流资源中读取 PDF 的原生支持
- 支持文件头之前的“无效”数据的文档
- 优化页面树解析
- 使用单个异常
- 几种测试类型(单元、功能测试和视觉测试)
我们尽量保持主要方法和逻辑流程与版本 1 相同,但请注意,有一些不兼容的更改,您在升级到版本 2 时应考虑
- 您需要使用
src/autoload.php
文件而不是classes/FPDI.php
来加载代码。 - 类和特性现在已命名空间:
setasign\Fpdi
- 以斜杠开头的页面边界,如
/MediaBox
,不再受支持。请删除斜杠或使用PdfReader\PageBoundaries
的常量。 - 现在
useTemplate()
或getTemplateSize()
方法的 $x、$y、$width 和 $height 参数具有更符合逻辑的默认值。传递0
作为宽度或高度现在将导致InvalidArgumentException
。 getTemplateSize()
的返回值现在已更改为具有更多说明性键和可重用性的数组:使用width
而不是w
,使用height
而不是h
。- 如果您想使用 FPDI 与 TCPDF 一起使用,您需要重构您的代码以使用类
Tcpdf\Fpdi
(自 2.1 版起;之前为TcpdfFpdi
)而不是FPDI
。
示例和文档
一个简单的示例,导入单个页面并将其放置在创建的新页面上
<?php use mailstreetdevelopment\fpdi\Fpdi; // or for usage with TCPDF: // use mailstreetdevelopment\fpdi\Tcpdf\Fpdi; // or for usage with tFPDF: // use mailstreetdevelopment\fpdi\Tfpdf\Fpdi; // setup the autoload function require_once('vendor/autoload.php'); // initiate FPDI $pdf = new Fpdi(); // add a page $pdf->AddPage(); // set the source file $pdf->setSourceFile("Fantastic-Speaker.pdf"); // import page 1 $tplId = $pdf->importPage(1); // use the imported page and place it at point 10,10 with a width of 100 mm $pdf->useTemplate($tplId, 10, 10, 100); $pdf->Output();
完整的用户文档和API参考手册可在此处找到。