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 |