API 參考
本章節提供 TCPDF-Next 所有公開 API 的結構化參考。依套件分類，快速查閱類別、介面與方法簽名。
快速導航
| 頁面 | 說明 |
|---|---|
| Document API | Document 類別的全部公開方法，依 12 個 Trait 分組 |
| 列舉參考 | 22 個列舉型別的完整定義（Orientation、Alignment、BlendMode 等） |
| 介面參考 | 核心介面定義（PdfDocumentInterface、FontManagerInterface、SignerInterface 等） |
| 值物件 API | PageSize、Margin、Position、Dimension、Unit、Color 的工廠方法與屬性 |
套件一覽
tcpdf-next/core
PDF 文件物件模型與生命週期管理。
| 類別 | 說明 |
|---|---|
Document | 公開 API 入口點，協調所有模組 |
ObjectRegistry | 間接物件的分配與追蹤 |
CrossReferenceStream | PDF 2.0 交叉參考串流 |
TransactionManager | 物件修改的批次提交與回滾 |
tcpdf-next/contracts
跨模組共用的介面與列舉型別。
| 匯出項目 | 類型 | 說明 |
|---|---|---|
PdfDocumentInterface | 介面 | 文件操作合約 |
FontManagerInterface | 介面 | 字型管理合約 |
SignerInterface | 介面 | 簽章操作合約 |
HsmSignerInterface | 介面 | HSM 硬體簽章合約 |
Orientation | 列舉 | 頁面方向（Portrait / Landscape） |
Alignment | 列舉 | 文字對齊方式 |
SignatureLevel | 列舉 | PAdES 簽章等級（B-B ~ B-LTA） |
OutputDestination | 列舉 | 輸出目的地（檔案 / 串流 / 字串） |
tcpdf-next/value-objects
不可變的值物件，確保型別安全與自我驗證。
| 類別 | 說明 |
|---|---|
PageSize | 標準與自訂頁面尺寸 |
Margin | 四邊邊距定義 |
Position | 二維座標點 |
Dimension | 二維尺寸（寬 x 高） |
Unit | 度量單位（mm / pt / in / cm） |
Color | 色彩值（RGB / CMYK / Gray / Hex） |
tcpdf-next/graphics
向量圖形繪製、色彩管理與圖片嵌入。
| 類別 | 說明 |
|---|---|
Canvas | Fluent 繪圖畫布 |
PathBuilder | 複雜向量路徑建構器 |
ColorManager | 多色彩空間管理 |
TransformMatrix | 2D 仿射變換 |
LayerManager | 可選內容圖層（OCG） |
ImageHandler | 圖片處理與嵌入 |
SvgImporter | SVG 向量圖匯入 |
tcpdf-next/typography
字型載入、Unicode 處理與雙向文字排版。
| 類別 | 說明 |
|---|---|
FontManager | 字型載入、快取與查詢 |
FontSubsetter | 字型子集化引擎 |
UnicodeHandler | Unicode 正規化與碼位映射 |
BidiAlgorithm | UAX #9 雙向演算法 |
ShapingEngine | 連字與上下文替換 |
tcpdf-next/content
文字渲染、儲存格與 JavaScript 動作。
| 類別 | 說明 |
|---|---|
TextRenderer | 文字轉 PDF 內容串流 |
TextStyle | 字型、色彩、行距等樣式 |
Cell / MultiCell | 單行 / 多行單元格渲染 |
JavaScriptAction | PDF 文件內嵌 JavaScript |
tcpdf-next/layout
頁面管理、頁首頁尾、多欄排版與騎馬釘裝。
| 類別 | 說明 |
|---|---|
PageManager | 頁面新增、切換與設定 |
HeaderFooter | 頁首頁尾回呼 |
ColumnLayout | 多欄排版引擎 |
BookletLayout | 騎馬釘裝頁面重排 |
tcpdf-next/html
HTML / CSS 解析與渲染。
| 類別 | 說明 |
|---|---|
HtmlRenderer | HTML 轉 PDF 渲染引擎 |
CssParser | CSS 樣式解析器 |
TableEngine | HTML 表格排版引擎 |
tcpdf-next/form
AcroForms 互動表單欄位。
| 類別 | 說明 |
|---|---|
FormManager | 表單欄位統一管理 |
TextField / CheckBox / RadioButton | 基本輸入元件 |
ComboBox / ListBox / PushButton | 選擇與按鈕元件 |
SignatureField | 簽章欄位定義 |
tcpdf-next/navigation
書籤、超連結、目錄與附件。
| 類別 | 說明 |
|---|---|
BookmarkManager | 書籤（大綱）管理 |
TocGenerator | 自動目錄生成 |
LinkManager | 超連結管理 |
AnnotationManager | 註解管理 |
AttachmentManager | 檔案附件 |
tcpdf-next/barcode
一維與二維條碼產生器。
| 類別 | 說明 |
|---|---|
BarcodeFactory | 統一條碼建立工廠 |
Barcode1D | 一維條碼（Code 128、EAN、UPC 等） |
Barcode2D / QrCode / DataMatrix / Pdf417 | 二維條碼 |
tcpdf-next/security
AES-256 加密與 PAdES 數位簽章。
| 類別 | 說明 |
|---|---|
EncryptionHandler | AES-256 加密處理器 |
SignatureManager | 數位簽章管理 |
PadesSignerBB ~ PadesSignerBLTA | 各等級 PAdES 簽署器 |
DssManager | 文件安全儲存區 |
TimestampClient | RFC 3161 時間戳記 |
tcpdf-next/archive
PDF/A-4 合規輸出與 XMP 中繼資料。
| 類別 | 說明 |
|---|---|
PdfAManager | PDF/A 合規管理 |
OutputIntent | 輸出意圖（ICC 色彩設定檔） |
XmpMetadata | XMP 中繼資料生成 |
ComplianceChecker | 合規性驗證 |
tcpdf-next/accessibility
Tagged PDF 與無障礙支援。
| 類別 | 說明 |
|---|---|
TagManager | 結構標記管理 |
StructureTree | 文件邏輯結構樹 |
ArtifactMarker | 裝飾性內容標記 |
AccessibilityChecker | 無障礙合規檢查 |
tcpdf-next/writer
PDF 2.0 二進位序列化引擎。
| 類別 | 說明 |
|---|---|
PdfWriter | 主要序列化引擎 |
StreamWriter | 串流壓縮與編碼 |
ViewerPreferences | 檢視器偏好設定 |
tcpdf-next/laravel
Laravel 12 框架整合。
| 類別 | 說明 |
|---|---|
TcpdfNextServiceProvider | 服務提供者 |
Pdf (Facade) | 門面類別 |
PdfResponse | PDF HTTP 回應 |
PdfMailAttachment | 郵件附件輔助 |
tcpdf-next/artisan
Laravel Artisan CLI 命令。
| 命令 | 說明 |
|---|---|
pdf:generate | 從範本生成 PDF |
pdf:fonts | 列出 / 安裝 / 快取字型 |
pdf:validate | 驗證 PDF/A 合規性 |
API 慣例
- 所有公開方法使用 camelCase 命名
- 所有類別使用 PascalCase 命名
- 建構子參數使用 PHP 8.2+ 具名引數
- 列舉值使用 PascalCase
- 所有回傳型別均有明確宣告
- 值物件皆為不可變（Immutable）
Document方法支援 Fluent Chaining（鏈式呼叫）
版本相容性
| TCPDF-Next 版本 | PHP 版本 | PDF 版本 | Laravel 版本 |
|---|---|---|---|
| 1.0.x | PHP 8.2+ | PDF 2.0 | Laravel 11 / 12 |
| 1.1.x | PHP 8.2+ | PDF 2.0 | Laravel 12 |