整合
NextPDF 擴充套件將核心 PDF 引擎銜接到應用程式 Framework(框架)、瀏覽器 renderer(渲染器)、邊緣服務、建置工具與舊版遷移。每個擴充套件章節都採用相同的手冊結構:概覽、安裝、快速上手、組態、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 建構器 |
選用指南
標題為「選用指南」的區段| 需求 | 從這裡開始 | 維運注意事項 |
|---|---|---|
| Framework 回應輔助工具 | Laravel、Symfony 或 CodeIgniter | framework 套件負責容器與回應整合;核心負責文件撰寫。 |
| 以像素為導向的 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 旗標與例外名稱維持為程式碼格式,方便翻譯工具保留。