FPDI 开源项目教程

1. 项目目录结构及介绍

FPDI 是一个基于 PHP 的类库，用于从现有的 PDF 文档中导入页面并作为模板在 FPDF 库中使用。以下是该项目的基本目录结构：

.
├── composer.json        # 项目依赖管理文件
├── composer.lock         # 锁定安装的依赖版本
├── local-tests           # 本地测试代码
│   └── ...
├── src                   # 源代码目录
│   ├── Fpdi.php          # 主要的 FPDI 类文件
│   └── ...               # 其他相关类文件
├── scratches             # 测试或实验性的代码
└── tests                 # 测试用例
    └── ...                # 测试文件

• src: 包含 FPDI 所有核心类文件，如 Fpdi.php，这是主要的 FPDI 类，负责导入 PDF 页面。
• local-tests: 存放用于本地测试的代码。
• tests: 测试套件，包括单元测试和其他测试文件，用于验证功能正确性。

2. 项目的启动文件介绍

FPDI 不提供一个特定的启动文件，因为它是作为一个库被集成到你的 PHP 项目中的。通常，你需要在你的 PHP 文件中引入 Fpdi.php 类来使用 FPDI 功能。例如：

require_once 'path/to/your/project/vendor/setasign/fpdi/src/Fpdi.php';

之后，你可以创建 Fpdi 实例并开始处理 PDF 文件。

use setasign\Fpdi\Fpdi;

$pdf = new Fpdi();
$pdf->setSourceFile('example.pdf');
$tplId = $pdf->importPage(1);
$pdf->addPage();
$pdf->useTemplate($tplId, 0, 0, 210, 297);
$pdf->Output();

这段代码导入了名为 "example.pdf" 的 PDF 文件的第一页，并将其添加到新的 PDF 页面上。

3. 项目的配置文件介绍

FPDI 使用 Composer 管理依赖，因此它的配置主要通过 composer.json 文件进行。这个文件定义了项目的依赖关系和元数据，但不包含项目运行时的配置。以下是一个基本的 composer.json 示例：

{
    "name": "setasign/fpdi",
    "description": "FPDI - Free PDF Document Importer",
    "type": "library",
    "require": {
        "setasign/setapdf-core": "^1.9",
        "setasign/setapdf-parser": "^1.2"
    },
    "license": "MIT",
    "authors": [
        {
            "name": "Frank Hofmann",
            "email": "[e-mail]",
            "homepage": "http://www.setasign.com/"
        }
    ],
    "autoload": {
        "psr-4": { "setasign\\Fpdi\\": "src/" }
    },
    "minimum-stability": "dev",
    "prefer-stable": true,
    "support": {
        "email": "[e-mail]",
        "issues": "https://gitlab.setasign.com/setaframework/fpdi/-/issues",
        "source": "https://gitlab.setasign.com/setaframework/fpdi"
    }
}

要启用 FPDI，在你的项目根目录下执行 composer require setasign/fpdi 来安装它。这样 Composer 将自动处理 FPDI 及其依赖的加载，无需额外的配置步骤。

请注意，如果项目需要自定义配置，你可能需要在你的应用级别设置这些配置，而不是在 FPDI 的本身。FPDI 旨在作为易于集成的工具，大多数配置选项将在你的主应用程序内完成。