整合 API 索引

概覽

當你已知道整合類型，但還不確定該看哪個套件專屬頁面時，請使用本頁。每一列都會連到該擴充套件章節的權威 API 參考。

這些 API 頁面都有原始碼佐證，並採用相同的表格結構：符號、參數、預設行為、回傳值、失敗模式與操作備註。

Framework（框架）API

涵蓋面	套件	主要符號	API 頁面
Laravel facade 與容器繫結	`nextpdf/laravel`	`Pdf`, `NextPdfServiceProvider`, `PdfDocumentInterface`, `DocumentFactoryInterface`	Laravel API 參考
Laravel HTTP 回應	`nextpdf/laravel`	`PdfResponse::inline`, `PdfResponse::download`, stream 回應輔助方法	Laravel API 參考
Laravel queue 工作	`nextpdf/laravel`	`GeneratePdfJob::handle`, `failed`, `then`, `catch`	Laravel API 參考
Symfony factory 與 bundle	`nextpdf/symfony`	`PdfFactory`, `NextPdfBundle`, `NextPdfExtension`, `Configuration`	Symfony API 參考
Symfony Messenger（訊息匯流排）	`nextpdf/symfony`	`GeneratePdfMessage`, `PdfBuilderInterface`, `GeneratePdfHandler`	Symfony API 參考
CodeIgniter service/library（服務/程式庫）	`nextpdf/codeigniter`	`Services`, `Pdf`, `pdf()`, `pdf_document()`	CodeIgniter API 參考
CodeIgniter queue 工作	`nextpdf/codeigniter`	`GeneratePdfJob::process`，靜態 builder（建構器）callable	CodeIgniter API 參考

渲染與轉換 API

涵蓋面	套件	主要符號	API 頁面
主機上的本機 Chrome 渲染	`nextpdf/artisan`	`ChromeHtmlRenderer`, `ChromeRendererConfig`, `ChromeRenderResult`, `BrowserPool`	Artisan API 參考
Chrome PDF 匯入	`nextpdf/artisan`	`PdfReader`, `PageImporter`, `ImportedFormXObject`, `PdfObject`	Artisan API 參考
底層 parser（剖析器）診斷	`nextpdf/artisan`	`PdfTokenizer`, `CrossRefParser`, `RevisionXRefTable`, `StreamDecoder`	Artisan API 參考
Cloudflare Browser Rendering（瀏覽器渲染）	`nextpdf/cloudflare`	`CloudflareHtmlRenderer`, `CloudflareRendererConfig`, `CloudflareRenderPayload`, `CloudflareResponseParser`	Cloudflare API 參考
Cloudflare API 保護	`nextpdf/cloudflare`	`ApiProtection`, `ApiProtectionConfig`, `ApiKeyValidator`, `RateLimitResult`	Cloudflare API 參考
Cloudflare R2 封存	`nextpdf/cloudflare`	`R2ArchiveManager`, `R2ArchiveConfig`, `R2ObjectKey`, `R2UploadResult`	Cloudflare API 參考
Gotenberg office 文件轉換	`nextpdf/gotenberg`	`GotenbergBridge`, `GotenbergConfig`, `GotenbergConvertPayload`, `GotenbergConvertResult`	Gotenberg API 參考
Gotenberg 格式與傳輸政策	`nextpdf/gotenberg`	`OfficeFormat`, `GotenbergSecurityPolicy`, `GotenbergResponseParser`, `PinnedCurlTransport`	Gotenberg API 參考

遷移與建置 API

涵蓋面	套件	主要符號	API 頁面
TCPDF adapter（轉接器）	`nextpdf/compat-legacy`	`TCPDF`, `CompatAdapterInterface`, `LegacyBootstrap`, `AdaptationConfig`	TCPDF 相容性 API 參考
TCPDF 方法族	`nextpdf/compat-legacy`	文字、字型、頁面、影像、繪圖、安全、表單與輸出等面向	TCPDF 方法涵蓋率
Backport 建置指令稿	`nextpdf/backport-builder`	`Build`, `MergeSources`, `AdjustComposer`, `ValidateBuildContract`	Backport Builder API 參考
Backport Rector 規則	`nextpdf/backport-builder`	`DowngradeAsymmetricVisibilityRector`, `DowngradeCloneWithRector`, `DowngradeTraitConstantsRector`	Backport Builder API 參考

依任務查找 API

任務	從這裡開始	接著閱讀
從 Framework 控制器回傳 PDF	`PdfResponse`，位於對應的 Framework 套件中。	套件的 `quickstart`，接著查看它的 `api` 回應表格。
在背景 worker 中產生 PDF	Laravel 的 `GeneratePdfJob`、Symfony 的 `GeneratePdfMessage`，或 CodeIgniter 的 `GeneratePdfJob`。	套件的 `developer-guide` 中的 queue 或 Messenger 模式。
以主機上的本機 Chrome 渲染 HTML	`ChromeHtmlRenderer::render()`。	Artisan 的設定、安全與生產環境用法頁面。
透過 Cloudflare 渲染 HTML	`CloudflareHtmlRenderer::render()`。	Cloudflare 的 API 保護與 Worker 操作頁面。
轉換 office 文件	`GotenbergBridge::convertFile()` 或 `convertString()`。	Gotenberg 的設定與疑難排解頁面。
將產生的 PDF 封存到物件儲存	`R2ArchiveManager::upload()` 與 `generateSignedUrl()`。	Cloudflare 的生產環境用法與安全頁面。
遷移 TCPDF 程式碼庫	`TCPDF`、方法涵蓋率，以及 `OutputBridge`。	TCPDF 相容性遷移指南。
為較舊的執行環境建置套件	`scripts/build.php` 與 `Build::run()`。	Backport 的開發者指南與生產環境用法。

依任務查找組態

任務	組態區域	套件頁面
設定文件中繼資料的預設值	`defaults.*`	Laravel、Symfony 或 CodeIgniter 的組態。
預熱生產環境字型	`preload_fonts` 或 `preloadFonts`	Framework 組態頁面。
設定 Chrome 執行檔與逾時時間	`artisan.*` 或 `ChromeRendererConfig`	Artisan 與 Framework 組態頁面。
設定簽章與 TSA	`signature.`, `tsa.`, `ocsp_cache.*`	Framework 組態頁面。
保護公開的渲染 endpoint	`ApiProtectionConfig`	Cloudflare 的 API 與安全頁面。
設定 R2 封存	`R2ArchiveConfig`	Cloudflare 的組態與 API 頁面。
設定 Gotenberg 服務	`GotenbergConfig`	Gotenberg 的組態與 API 頁面。
調整相容性行為	`AdaptationConfig`	TCPDF 相容性組態頁面。

失敗模式 Index（索引）

症狀	可能的 API 邊界	第一個診斷頁面
下載回應的檔名錯誤	Framework 的 `PdfResponse` 輔助方法。	對應的 Framework API 頁面。
queue 工作在渲染前即失敗	工作/訊息驗證。	對應的 Framework 疑難排解頁面。
Chrome 渲染逾時	`ChromeHtmlRenderer` 或 `BrowserPool`。	Artisan 疑難排解頁面。
worker 回傳非 PDF 資料	`CloudflareResponseParser`。	Cloudflare 疑難排解頁面。
R2 上傳成功但 URL 無法使用	`R2UploadResult` 或簽署 URL 的產生。	Cloudflare 生產環境用法頁面。
office 檔案被拒絕	`OfficeFormat` 或 `GotenbergSecurityPolicy`。	Gotenberg 疑難排解頁面。
舊版 TCPDF 方法擲出例外	相容性層面或例外工廠。	TCPDF 方法涵蓋率頁面。
Backport 輸出未通過語法檢查	Rector 組態或自訂規則。	Backport 開發者指南。

項目契約

每個套件的 API 頁面都應該記錄下列內容：

必要細節	原因
完整限定的符號	讓讀者不必猜 namespace 就能搜尋原始碼與測試。
參數名稱與預設值	避免呼叫端產生歧義，並支援具型別的範例。
預設行為	讓呼叫端能安全地刻意省略選用輸入。
回傳值或副作用	指出該方法是 fluent、終端，還是診斷型。
失敗模式	協助生產程式碼採 fail-closed，並記錄正確的邊界。
操作備註	涵蓋 worker 安全性、資安、記憶體、逾時或相容性等面向。