統合
NextPDF 拡張は、コア PDF エンジンをアプリケーションフレームワーク、ブラウザーレンダラー、エッジサービス、ビルドツール、レガシー移行と連携させます。各拡張のセクションは、概要、インストール、クイックスタート、構成、API、開発者ガイド、本番利用、セキュリティ、トラブルシューティングという共通のマニュアル構成に従っています。
拡張マップ
「拡張マップ」という見出しのセクション| 拡張 | パッケージ | 使用する場面 | メインセクション |
|---|---|---|---|
| Laravel | nextpdf/laravel | Laravel アプリケーションを構築していて、コンテナーバインディング、ファサード、レスポンス、キュージョブが必要な場合。 | Laravel |
| Symfony | nextpdf/symfony | Symfony アプリケーションを構築していて、バンドル、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 サービス経由でオフィスドキュメントまたは HTML を変換する場合。 | Gotenberg |
| TCPDF 互換性 | nextpdf/compat-legacy | TCPDF 形式のアプリケーションコードを、全面的に書き換えずに NextPDF へ移行する場合。 | TCPDF 互換性 |
| Backport Builder | nextpdf/backport-builder | 古い PHP ランタイム向けのリリース成果物を保守する場合。 | Backport Builder |
選択ガイド
「選択ガイド」という見出しのセクション| ニーズ | 出発点 | 運用上の注意 |
|---|---|---|
| フレームワークのレスポンスヘルパー | Laravel、Symfony、または CodeIgniter | フレームワークパッケージはコンテナーとレスポンスの統合を担い、コアはドキュメント作成を担います。 |
| ピクセル単位の HTML レンダリング | Artisan または Cloudflare | ホスト側のローカル Chrome CDP には Artisan を選択し、レンダリングをエッジで行う場合は Cloudflare を選択します。 |
| オフィス文書の変換 | Gotenberg | Gotenberg は、タイムアウト、サイズ、SSRF の制御を備えた外部サービス境界として扱います。 |
| レガシー TCPDF からの移行 | TCPDF 互換性 | レガシー呼び出しがサポート対象だと見なす前に、メソッドカバレッジ表を確認してください。 |
| 古い PHP ディストリビューション | Backport Builder | ビルドツール専用です。アプリケーションのランタイム依存関係としてインストールしないでください。 |
マニュアル構成
「マニュアル構成」という見出しのセクション各拡張のセクションには、次のページタイプが含まれます。
| ページ | 目的 |
|---|---|
overview | 製品の境界、対象読者、サポートされるワークフロー、制限事項。 |
install | インストールコマンドと必要なランタイム依存関係。 |
quickstart | コピーして試せる最初の結果を含む、最小限の動作フロー。 |
configuration | サポートされるすべての構成キー、環境変数、デフォルト値、効果。 |
api | パブリッククラス、メソッド、パラメーター、デフォルト値、戻り値、例外。 |
developer-guide | 拡張のアーキテクチャ、ライフサイクル、拡張ポイント、コード構成。 |
production-usage | デプロイ、信頼性、パフォーマンス、ワーカーの安全性、可観測性。 |
security-and-operations | 信頼境界、安全なデフォルト値、シークレット、ファイルアクセス、運用上の制御。 |
troubleshooting | 症状、診断、考えられる原因、是正措置。 |
API 表の規約
「API 表の規約」という見出しのセクションAPI 表ではマニュアル全体で同じ列を使用しているため、読者は新しいレイアウトを覚え直さずにパッケージを比較できます。
| 列 | 意味 |
|---|---|
| シンボル | 完全修飾されたクラス、メソッド、エンドポイント、CLI コマンド、または構成オブジェクト。 |
| パラメーター | 名前、型、必須かどうか、デフォルト値、許容される値。 |
| デフォルトの動作 | 呼び出し元がオプション入力を省略した場合に起こること。 |
| 戻り値 | 戻り値の型または出力成果物。 |
| スローまたは失敗する条件 | 例外の型、HTTP ステータス、検証失敗、運用上の障害モード。 |
| 備考 | セキュリティ、ワーカーの安全性、互換性、パフォーマンスに関する詳細。 |
翻訳への対応
「翻訳への対応」という見出しのセクション英語のソースは後続のローカライズを前提として記述されています。短いセクション、安定した見出し、明示的な名詞、慣用句の回避、繰り返し構造を示す表を使用しています。新しい API ページでは、翻訳ツールが保持できるよう、メソッド名、構成キー、CLI フラグ、例外名をコード書式のままにしてください。