APIリファレンス
TCPDF-Nextエコシステムの全パッケージの完全なAPIリファレンスです。各パッケージの主要なクラスとインターフェースを以下に記載しています。メソッドシグネチャ、パラメータ、使用例については、各専用ページをご参照ください。
Core
パッケージ: tcpdf-next/core
| クラス | 説明 |
|---|---|
Document | 中心的なエントリーポイント -- 12のトレイトに委譲するフルエントファサード |
ObjectRegistry | すべてのPDF間接オブジェクトを追跡し、一意のオブジェクト番号を割り当て |
TransactionManager | 複雑なレイアウト操作のためのセーブポイント/ロールバックセマンティクス |
CrossReferenceStream | PDF 2.0バイナリクロスリファレンスストリームの構築 |
Contracts
パッケージ: tcpdf-next/contracts
| インターフェース / Enum | 種別 | 説明 |
|---|---|---|
PdfDocumentInterface | インターフェース | PDF ドキュメント実装の主要なAPIコントラクト |
FontManagerInterface | インターフェース | フォントの読み込み、登録、サブセット化のコントラクト |
SignerInterface | インターフェース | デジタル署名プロバイダの抽象化 |
HsmSignerInterface | インターフェース | ハードウェアセキュリティモジュール用拡張署名者 |
Orientation | Enum | ページの向き（縦、横） |
Alignment | Enum | テキスト揃え（左、中央、右、両端揃え） |
OutputDestination | Enum | 出力先（インライン、ダウンロード、ファイル、文字列） |
SignatureLevel | Enum | PAdES準拠レベル（B-BからB-LTA） |
値オブジェクト
パッケージ: tcpdf-next/value-objects
| クラス | 説明 |
|---|---|
PageSize | 名前付きまたはカスタムページサイズ、プリセットファクトリ付き（A0 -- A6、Letter、Legal、Tabloid） |
Margin | 四辺のページマージン（上、右、下、左） |
Position | 不変のx--y座標 |
Dimension | 不変の幅--高さペア |
Unit | 単位変換ヘルパー（mm、pt、cm、in） |
Graphics
パッケージ: tcpdf-next/graphics
| クラス | 説明 |
|---|---|
Color | 不変のカラー表現（RGB、CMYK、Gray、Spot） |
ColorSpace | DeviceRGB、DeviceCMYK、DeviceGray、SeparationのEnum |
BlendMode | 透過ブレンドモードEnum（Normal、Multiply、Screen、Overlay、...） |
LayerManager | オプショナルコンテンツグループ（OCG）管理 |
GradientManager | 線形および放射グラデーションの作成 |
Typography
パッケージ: tcpdf-next/typography
| クラス | 説明 |
|---|---|
FontManager | フォントの読み込みと管理のための中央レジストリ |
FontSubsetter | 使用されたグリフのみを含む最小フォントサブセットの作成 |
FontInfo | グリフメトリクス、アセンダ、ディセンダを公開する読み取り専用データオブジェクト |
BiDiResolver | Unicode双方向アルゴリズム（UAX #9）の実装 |
Content
パッケージ: tcpdf-next/content
| クラス | 説明 |
|---|---|
TextRenderer | シャドウやエフェクト付きの高レベルテキストレンダリング |
JavaScriptManager | ドキュメントレベルのJavaScriptアクションの埋め込み |
Layout
パッケージ: tcpdf-next/layout
| クラス | 説明 |
|---|---|
PageManager | ページの追跡、改ページ処理、現在のページ状態管理 |
HeaderFooterManager | 繰り返しヘッダーとフッターのコンテンツ管理 |
ColumnManager | マルチカラムコンテンツフロー |
BookletManager | 中綴じ製本印刷のためのページ面付け |
Html
パッケージ: tcpdf-next/html
| クラス | 説明 |
|---|---|
HtmlParser | HTMLマークアップをレンダリング用のDOMツリーに解析 |
CssRule | 詳細度を持つ解決済みCSSルールを表現 |
TableParser | HTMLテーブルレイアウト専用のパーサー |
Form
パッケージ: tcpdf-next/form
| クラス | 説明 |
|---|---|
FormFieldManager | AcroFormフィールドの作成と管理 |
FormFieldType | フィールドタイプのEnum（Text、Password、Textarea、Checkbox、Radio、Listbox、Combobox、Button） |
Navigation
パッケージ: tcpdf-next/navigation
| クラス | 説明 |
|---|---|
BookmarkManager | ドキュメントアウトラインエントリの作成とネスト |
AnnotationManager | マークアップ注釈の追加（ハイライト、メモ、下線） |
FileAttachment | ドキュメントへのファイル添付の埋め込み |
TocManager | 目次の自動生成 |
Barcode
パッケージ: tcpdf-next/barcode
| クラス | 説明 |
|---|---|
BarcodeGenerator | すべてのバーコードタイプの統合ファクトリ |
BarcodeType | 1Dバーコード用Enum（CODE_39、CODE_128、EAN_13、...） |
Barcode2DType | 2Dバーコード用Enum（QR_CODE、DATAMATRIX、PDF417） |
Security
パッケージ: tcpdf-next/security
| クラス | 説明 |
|---|---|
Aes256Encryptor | AESV3ハンドラによるAES-256暗号化 |
DigitalSigner | PAdESデジタル署名の作成 |
TsaClient | RFC 3161タイムスタンプ局クライアント |
LtvManager | DSS、OCSPステープリング、CRL埋め込みによる長期検証 |
DssBuilder | ドキュメントセキュリティストアディクショナリの構築 |
Archive
パッケージ: tcpdf-next/archive
| クラス | 説明 |
|---|---|
PdfAManager | PDF/A-4準拠の強制とバリデーション |
XmpMetadata | XMPメタデータパケットの生成（ISO 16684） |
OutputIntent | ICCアウトプットインテントプロファイルの管理 |
Accessibility
パッケージ: tcpdf-next/accessibility
| クラス | 説明 |
|---|---|
StructureTreeManager | タグ付きPDF構造ツリーの管理 |
RoleMap | カスタムタグから標準PDF構造タイプへのマッピング |
Writer
パッケージ: tcpdf-next/writer
| クラス | 説明 |
|---|---|
PdfWriter | オブジェクトレジストリからバイナリPDF出力を調整 |
Linearizer | リニアライズ（Web最適化）PDF出力の生成 |
Laravel
パッケージ: tcpdf-next/laravel
| クラス | 説明 |
|---|---|
TcpdfServiceProvider | バインディングの登録と設定の公開 |
Pdf（ファサード） | Document::create()の静的ファサード |
PdfResponse | PDFをLaravel HTTPレスポンスとして返却 |
GeneratePdfJob | バックグラウンドPDF生成用のキュー可能ジョブ |
Artisan
パッケージ: tcpdf-next/artisan
| クラス | 説明 |
|---|---|
HtmlRenderer | CLI経由でBlade / HTMLテンプレートをPDFにレンダリング |
ChromeBridge | ピクセルパーフェクトレンダリング用ヘッドレスChrome統合 |
RenderOptions | Artisanレンダーコマンド用設定DTO |
さらに詳しく
- Document API --
Documentクラスのすべてのパブリックメソッド - 列挙型リファレンス -- 値と使い方を含む全22列挙型
- インターフェースリファレンス -- DIとテスト用のコントラクトインターフェース
- 値オブジェクトAPI -- ファクトリメソッド、プロパティ、変換