API 參考
本章節提供 TCPDF-Next 生態圈中每個套件的完整 API 參考。以下依套件列出關鍵類別與介面，點擊連結可查看方法簽名、參數與使用範例。
Core
套件： tcpdf-next/core
| 類別 | 說明 |
|---|---|
Document | 核心入口點 — fluent 門面，委派至 12 個 Trait |
ObjectRegistry | 追蹤所有 PDF 間接物件並分配唯一物件編號 |
TransactionManager | 複雜排版操作的儲存點 / 回滾語意 |
CrossReferenceStream | 建構 PDF 2.0 二進位交叉參考串流 |
Contracts
套件： tcpdf-next/contracts
| 介面 / 列舉 | 類型 | 說明 |
|---|---|---|
PdfDocumentInterface | 介面 | 任何 PDF 文件實作的主要 API 合約 |
FontManagerInterface | 介面 | 字型載入、註冊與子集化合約 |
SignerInterface | 介面 | 數位簽章提供者抽象 |
HsmSignerInterface | 介面 | 硬體安全模組的擴充簽章介面 |
Orientation | 列舉 | 頁面方向（Portrait、Landscape） |
Alignment | 列舉 | 文字對齊（Left、Center、Right、Justified） |
OutputDestination | 列舉 | 輸出目的地（Inline、Download、File、String） |
SignatureLevel | 列舉 | PAdES 合規等級（B-B 至 B-LTA） |
Value Objects
套件： 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 列舉 |
BlendMode | 透明度混合模式列舉（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 | 欄位類型列舉（Text、Password、Textarea、Checkbox、Radio、Listbox、Combobox、Button） |
Navigation
套件： tcpdf-next/navigation
| 類別 | 說明 |
|---|---|
BookmarkManager | 建立與巢狀文件大綱項目 |
AnnotationManager | 新增標記註解（醒目提示、附註、底線） |
FileAttachment | 在文件中嵌入檔案附件 |
TocManager | 自動目錄生成 |
Barcode
套件： tcpdf-next/barcode
| 類別 | 說明 |
|---|---|
BarcodeGenerator | 所有條碼類型的統一工廠 |
BarcodeType | 一維條碼列舉（CODE_39、CODE_128、EAN_13...） |
Barcode2DType | 二維條碼列舉（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 | 管理 Tagged PDF 結構樹 |
RoleMap | 將自訂標籤映射至標準 PDF 結構類型 |
Writer
套件： tcpdf-next/writer
| 類別 | 說明 |
|---|---|
PdfWriter | 從物件註冊中心協調二進位 PDF 輸出 |
Linearizer | 產生線性化（Web 最佳化）PDF 輸出 |
Laravel
套件： tcpdf-next/laravel
| 類別 | 說明 |
|---|---|
TcpdfServiceProvider | 註冊繫結並發佈設定 |
Pdf (Facade) | Document::createStandalone() 的靜態門面 |
PdfResponse | 以 Laravel HTTP 回應方式回傳 PDF |
GeneratePdfJob | 可排入佇列的背景 PDF 生成任務 |
Symfony
套件： tcpdf-next/symfony
| 類別 | 說明 |
|---|---|
TcpdfNextBundle | Symfony Bundle 註冊與服務接線 |
PdfFactory | DI 友善的 PDF 文件建立工廠 |
PdfResponse | 以 Symfony HTTP 回應方式回傳 PDF |
GeneratePdfMessage | 用於非同步 PDF 生成的 Messenger 訊息 |
CodeIgniter
套件： tcpdf-next/codeigniter
| 類別 | 說明 |
|---|---|
TcpdfNextService | CodeIgniter 服務註冊 |
PdfLibrary | 供 CodeIgniter 控制器使用的 Library 類別 |
PdfResponse | 以 CodeIgniter HTTP 回應方式回傳 PDF |
GeneratePdfJob | 背景 PDF 生成的佇列任務 |
Artisan
套件： tcpdf-next/artisan
| 類別 | 說明 |
|---|---|
HtmlRenderer | 透過 Chrome CDP 將 Blade / HTML 範本渲染為 PDF |
ChromeBridge | Headless Chrome 整合，實現完美像素渲染 |
RenderOptions | Artisan 渲染命令的設定 DTO |
Adaptation
套件： tcpdf-next/adaptation
| 類別 | 說明 |
|---|---|
TCPDF | 非 final 轉接器類別，將 252 個舊版 TCPDF 方法映射至 TCPDF-Next |
TCPDF_STATIC | 靜態輔助相容層 |
TCPDF_FONTS | 字型輔助相容層 |
TCPDF_COLORS | 色彩輔助相容層 |
TCPDF_IMAGES | 圖片輔助相容層 |
延伸閱讀
- Document API --
Document類別的每個公開方法 - 列舉參考 -- 全部 22 個列舉及其值與用法
- 介面參考 -- 用於 DI 與測試的合約介面
- 值物件 API -- 工廠方法、屬性與轉換