集成
NextPDF 扩展将核心 PDF 引擎接入应用框架、浏览器渲染器、边缘服务、构建工具以及旧版迁移流程。每个扩展章节都遵循相同的手册结构:概述、安装、快速开始、配置、API、开发者指南、生产使用、安全性以及故障排除。
扩展一览
标题为“扩展一览”的章节| 扩展 | 包 | 适用场景 | 主章节 |
|---|---|---|---|
| Laravel | nextpdf/laravel | 你正在构建 Laravel 应用,并希望使用容器绑定、外观(facade)、响应和队列任务。 | Laravel |
| Symfony | nextpdf/symfony | 你正在构建 Symfony 应用,并希望使用 bundle、DI 装配、Messenger 任务和 HTTP 响应。 | Symfony |
| CodeIgniter | nextpdf/codeigniter | 你正在构建 CodeIgniter 4 应用,并希望使用服务、库封装、响应和队列任务。 | CodeIgniter |
| Artisan | nextpdf/artisan | 你需要基于 Chrome CDP 的 HTML 渲染、页面导入,或底层 PDF 检视工具。 | Artisan |
| Cloudflare | nextpdf/cloudflare | 你通过 Cloudflare Browser Rendering 进行渲染、保护 API 访问,或将 PDF 归档到 R2。 | Cloudflare |
| Gotenberg | nextpdf/gotenberg | 你通过 Gotenberg 服务转换 Office 文档或 HTML。 | Gotenberg |
| TCPDF 兼容性 | nextpdf/compat-legacy | 你要将 TCPDF 风格的应用程序代码迁移到 NextPDF,而无需全面重写。 | TCPDF 兼容性 |
| Backport 构建器 | nextpdf/backport-builder | 你要为较旧的 PHP 运行时维护发布产物。 | Backport 构建器 |
选用指南
标题为“选用指南”的章节| 需求 | 从这里开始 | 运维注意事项 |
|---|---|---|
| 框架响应辅助工具 | Laravel、Symfony 或 CodeIgniter | 框架包负责容器与响应集成;核心负责文档撰写。 |
| 面向像素精度的 HTML 渲染 | Artisan 或 Cloudflare | 需要主机本地 Chrome CDP 时选择 Artisan;需要将渲染放到边缘时选择 Cloudflare。 |
| Office 文档转换 | Gotenberg | 将 Gotenberg 视为外部服务边界,并施加超时、大小和 SSRF 控制。 |
| 旧版 TCPDF 迁移 | TCPDF 兼容性 | 在认定某个旧版调用受支持之前,先查阅方法覆盖对照表。 |
| 较旧的 PHP 版本 | Backport 构建器 | 仅将其作为构建工具;请勿把它安装为应用程序运行时依赖包。 |
手册结构
标题为“手册结构”的章节每个扩展章节都包含这些页面类型:
| 页面 | 用途 |
|---|---|
overview | 产品边界、目标受众、支持的工作流程与限制。 |
install | 安装命令和必要的运行时依赖包。 |
quickstart | 最小可运行流程,附带可复制的首个结果。 |
configuration | 每个受支持的配置键、环境变量、默认值和作用。 |
api | 公开类、方法、参数、默认值、返回值与异常。 |
developer-guide | 扩展架构、生命周期、扩展点和代码组织。 |
production-usage | 部署、可靠性、性能、worker 安全性和可观测性。 |
security-and-operations | 信任边界、安全默认值、机密、文件访问和运维控制。 |
troubleshooting | 症状、诊断、可能原因和纠正措施。 |
API 表格惯例
标题为“API 表格惯例”的章节整本手册的 API 表格都使用相同列,读者无需重新熟悉布局即可比较各个包。
| 列 | 含义 |
|---|---|
| 符号 | 完整限定类、方法、endpoint、CLI 命令或配置对象。 |
| 参数 | 名称、类型、是否必填、默认值和可接受的值。 |
| 默认行为 | 调用方省略可选输入时的行为。 |
| 返回 | 返回类型或输出产物。 |
| 抛出或失败形式 | 异常类型、HTTP 状态、验证失败或运维失败模式。 |
| 备注 | 安全性、worker 安全性、兼容性或性能细节。 |
翻译就绪性
标题为“翻译就绪性”的章节英文原文为后续本地化而撰写:章节简短、标题稳定、术语明确、避免惯用表达,并用表格呈现重复结构。新的 API 页面应将方法名称、配置键、CLI 标志和异常名称保留为代码格式,便于翻译工具识别并保留。