Skip to content

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)
ColorSpaceDeviceRGB、DeviceCMYK、DeviceGray、Separation 列舉
BlendMode透明度混合模式列舉(Normal、Multiply、Screen、Overlay...)
LayerManager可選內容群組 (OCG) 管理
GradientManager線性與放射漸層建立

Typography

套件: tcpdf-next/typography

類別說明
FontManager字型載入與管理的核心註冊中心
FontSubsetter建立僅包含使用字符的最小字型子集
FontInfo公開字符度量、升部線、降部線的唯讀資料物件
BiDiResolverUnicode 雙向演算法 (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 規則
TableParserHTML 表格排版的專用解析器

Form

套件: tcpdf-next/form

類別說明
FormFieldManager建立與管理 AcroForm 欄位
FormFieldType欄位類型列舉(Text、Password、Textarea、Checkbox、Radio、Listbox、Combobox、Button)

套件: 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

類別說明
Aes256EncryptorAESV3 處理器的 AES-256 加密
DigitalSignerPAdES 數位簽章建立
TsaClientRFC 3161 時間戳記授權用戶端
LtvManager透過 DSS、OCSP 裝訂與 CRL 嵌入實現長期驗證
DssBuilder建構文件安全儲存區字典

Archive

套件: tcpdf-next/archive

類別說明
PdfAManagerPDF/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

類別說明
TcpdfNextBundleSymfony Bundle 註冊與服務接線
PdfFactoryDI 友善的 PDF 文件建立工廠
PdfResponse以 Symfony HTTP 回應方式回傳 PDF
GeneratePdfMessage用於非同步 PDF 生成的 Messenger 訊息

CodeIgniter

套件: tcpdf-next/codeigniter

類別說明
TcpdfNextServiceCodeIgniter 服務註冊
PdfLibrary供 CodeIgniter 控制器使用的 Library 類別
PdfResponse以 CodeIgniter HTTP 回應方式回傳 PDF
GeneratePdfJob背景 PDF 生成的佇列任務

Artisan

套件: tcpdf-next/artisan

類別說明
HtmlRenderer透過 Chrome CDP 將 Blade / HTML 範本渲染為 PDF
ChromeBridgeHeadless Chrome 整合,實現完美像素渲染
RenderOptionsArtisan 渲染命令的設定 DTO

Adaptation

套件: tcpdf-next/adaptation

類別說明
TCPDF非 final 轉接器類別,將 252 個舊版 TCPDF 方法映射至 TCPDF-Next
TCPDF_STATIC靜態輔助相容層
TCPDF_FONTS字型輔助相容層
TCPDF_COLORS色彩輔助相容層
TCPDF_IMAGES圖片輔助相容層

延伸閱讀

以 LGPL-3.0-or-later 授權釋出。