コンテンツにスキップ

統合 API インデックス

概要

統合の種類はわかっているものの、該当するパッケージ固有のページがわからない場合は、このページを参照してください。各行から、その拡張機能セクションの正式な API リファレンスへ移動できます。

API ページはソースに基づいており、シンボル、パラメーター、デフォルトの動作、戻り値、失敗モード、操作上の注意を同じ表形式で記載しています。

フレームワーク API

サーフェス	パッケージ	主要なシンボル	API ページ
Laravel ファサードおよびコンテナーバインディング	`nextpdf/laravel`	`Pdf`, `NextPdfServiceProvider`, `PdfDocumentInterface`, `DocumentFactoryInterface`	Laravel API
Laravel HTTP レスポンス	`nextpdf/laravel`	`PdfResponse::inline`、`PdfResponse::download`、ストリームレスポンスヘルパー	Laravel API
Laravel キュージョブ	`nextpdf/laravel`	`GeneratePdfJob::handle`、`failed`、`then`、`catch`	Laravel API
Symfony ファクトリーおよびバンドル	`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 キュージョブ	`nextpdf/codeigniter`	`GeneratePdfJob::process`、静的ビルダー callable	CodeIgniter API

レンダリングおよび変換 API

サーフェス	パッケージ	主要なシンボル	API ページ
ホストローカルの Chrome レンダリング	`nextpdf/artisan`	`ChromeHtmlRenderer`、`ChromeRendererConfig`、`ChromeRenderResult`、`BrowserPool`	Artisan API
Chrome PDF インポート	`nextpdf/artisan`	`PdfReader`、`PageImporter`、`ImportedFormXObject`、`PdfObject`	Artisan API
低レベルパーサーの診断	`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 アダプター	`nextpdf/compat-legacy`	`TCPDF`、`CompatAdapterInterface`、`LegacyBootstrap`、`AdaptationConfig`	TCPDF compatibility API
TCPDF メソッドファミリー	`nextpdf/compat-legacy`	テキスト、フォント、ページ、画像、描画、セキュリティ、フォーム、出力に関する事項	TCPDF method coverage
バックポートのビルドスクリプト	`nextpdf/backport-builder`	`Build`、`MergeSources`、`AdjustComposer`、`ValidateBuildContract`	Backport Builder API
バックポートの Rector ルール	`nextpdf/backport-builder`	`DowngradeAsymmetricVisibilityRector`、`DowngradeCloneWithRector`、`DowngradeTraitConstantsRector`	Backport Builder API

タスク別 API

タスク	最初に参照	次に参照
フレームワークのコントローラーから PDF を返す	対応するフレームワークパッケージ内で `PdfResponse` を使用します。	パッケージの `quickstart`、続いてその `api` レスポンス表。
バックグラウンドワーカーで PDF を生成する	Laravel `GeneratePdfJob`、Symfony `GeneratePdfMessage`、または CodeIgniter `GeneratePdfJob`。	パッケージの `developer-guide` にあるキューまたは 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()`。	バックポートの開発者ガイドおよび本番利用。

タスク別の構成

タスク	構成領域	パッケージページ
ドキュメントメタデータのデフォルトを設定する	`defaults.*`	Laravel、Symfony、または CodeIgniter の構成。
本番用フォントをウォームアップする	`preload_fonts` or `preloadFonts`	フレームワーク構成ページ。
Chrome バイナリとタイムアウトを構成する	`artisan.*` or `ChromeRendererConfig`	Artisan およびフレームワーク構成ページ。
署名および TSA を構成する	`signature.`、`tsa.`、`ocsp_cache.*`	フレームワーク構成ページ。
公開レンダリングエンドポイントを保護する	`ApiProtectionConfig`	Cloudflare API およびセキュリティの各ページ。
R2 アーカイブを構成する	`R2ArchiveConfig`	Cloudflare の構成および API の各ページ。
Gotenberg サービスを構成する	`GotenbergConfig`	Gotenberg の構成および API の各ページ。
互換性の動作を調整する	`AdaptationConfig`	TCPDF 互換性の構成ページ。

失敗モードのインデックス

症状	想定される API 境界	最初に確認する診断ページ
レスポンスが誤ったファイル名でダウンロードされる	フレームワークの `PdfResponse` ヘルパー。	対応するフレームワークの API ページ。
キュージョブがレンダリング前に失敗する	ジョブ/メッセージの検証。	対応するフレームワークのトラブルシューティングページ。
Chrome のレンダリングがタイムアウトする	`ChromeHtmlRenderer` または `BrowserPool`。	Artisan のトラブルシューティングページ。
Worker が PDF 以外のデータを返す	`CloudflareResponseParser`。	Cloudflare のトラブルシューティングページ。
R2 アップロードは成功するが URL を使用できない	`R2UploadResult` または署名付き URL の生成。	Cloudflare の本番利用ページ。
Office ファイルが拒否される	`OfficeFormat` または `GotenbergSecurityPolicy`。	Gotenberg のトラブルシューティングページ。
レガシー TCPDF メソッドが例外をスローする	互換性に関する事項または例外ファクトリー。	TCPDF メソッドカバレッジページ。
バックポート出力が構文チェックに失敗する	Rector の構成またはカスタムルール。	バックポートの開発者ガイド。

エントリー契約

各パッケージの API ページでは、次の項目を記載することが求められます。

必須の詳細	理由
完全修飾シンボル	名前空間を推測することなく、読者がソースやテストを検索できるようにします。
パラメーター名とデフォルト	呼び出し側の曖昧さを防ぎ、型付きの例を支えます。
デフォルトの動作	省略可能な入力を意図的に安全に省略できるようにします。
戻り値または副作用	メソッドがフルーエント、ターミナル、診断のいずれであるかを示します。
失敗モード	本番コードがフェイルクローズし、適切な境界をログに記録できるようにします。
操作上の注意	ワーカーの安全性、セキュリティ、メモリ、タイムアウト、または互換性に関する事項を記載します。