Referência da API
Referência completa da API para todos os pacotes do ecossistema TCPDF-Next. Cada pacote é listado abaixo com suas classes e interfaces principais. Clique nos links para acessar as páginas dedicadas com assinaturas de métodos, parâmetros e exemplos de uso.
Core
Pacote: tcpdf-next/core
| Classe | Descrição |
|---|---|
Document | Ponto de entrada central -- facade fluente que delega para 12 traits |
ObjectRegistry | Rastreia todos os objetos indiretos PDF e atribui números de objeto únicos |
TransactionManager | Semântica de savepoint / rollback para operações complexas de layout |
CrossReferenceStream | Constrói o stream de referência cruzada binário PDF 2.0 |
Contracts
Pacote: tcpdf-next/contracts
| Interface / Enum | Tipo | Descrição |
|---|---|---|
PdfDocumentInterface | Interface | Contrato principal da API para qualquer implementação de documento PDF |
FontManagerInterface | Interface | Contrato de carregamento, registro e subconjunto de fontes |
SignerInterface | Interface | Abstração de provedor de assinatura digital |
HsmSignerInterface | Interface | Assinador estendido para módulos de segurança de hardware |
Orientation | Enum | Orientação da página (Portrait, Landscape) |
Alignment | Enum | Alinhamento de texto (Left, Center, Right, Justified) |
OutputDestination | Enum | Destino de saída (Inline, Download, File, String) |
SignatureLevel | Enum | Nível de conformidade PAdES (B-B até B-LTA) |
Value Objects
Pacote: tcpdf-next/value-objects
| Classe | Descrição |
|---|---|
PageSize | Tamanho de página nomeado ou personalizado com fábricas predefinidas (A0 -- A6, Letter, Legal, Tabloid) |
Margin | Margens de página de quatro lados (top, right, bottom, left) |
Position | Coordenada x--y imutável |
Dimension | Par largura--altura imutável |
Unit | Auxiliares de conversão de unidades (mm, pt, cm, in) |
Graphics
Pacote: tcpdf-next/graphics
| Classe | Descrição |
|---|---|
Color | Representação de cor imutável (RGB, CMYK, Gray, Spot) |
ColorSpace | Enum para DeviceRGB, DeviceCMYK, DeviceGray, Separation |
BlendMode | Enum de modo de mesclagem de transparência (Normal, Multiply, Screen, Overlay, ...) |
LayerManager | Gerenciamento de Optional Content Group (OCG) |
GradientManager | Criação de gradientes lineares e radiais |
Typography
Pacote: tcpdf-next/typography
| Classe | Descrição |
|---|---|
FontManager | Registro central para carregar e gerenciar fontes |
FontSubsetter | Cria subconjuntos mínimos de fontes contendo apenas glifos usados |
FontInfo | Objeto de dados readonly expondo métricas de glifos, ascender, descender |
BiDiResolver | Implementação do Unicode Bidirectional Algorithm (UAX #9) |
Content
Pacote: tcpdf-next/content
| Classe | Descrição |
|---|---|
TextRenderer | Renderização de texto de alto nível com sombras e efeitos |
JavaScriptManager | Incorpora ações JavaScript em nível de documento |
Layout
Pacote: tcpdf-next/layout
| Classe | Descrição |
|---|---|
PageManager | Rastreia páginas, gerencia quebras de página, gerencia estado da página atual |
HeaderFooterManager | Gerenciamento de conteúdo repetido de cabeçalho e rodapé |
ColumnManager | Fluxo de conteúdo multi-coluna |
BookletManager | Impõe páginas para impressão em caderno de sela |
Html
Pacote: tcpdf-next/html
| Classe | Descrição |
|---|---|
HtmlParser | Analisa marcação HTML em uma árvore DOM para renderização |
CssRule | Representa uma única regra CSS resolvida com especificidade |
TableParser | Analisador especializado para layout de tabela HTML |
Form
Pacote: tcpdf-next/form
| Classe | Descrição |
|---|---|
FormFieldManager | Cria e gerencia campos AcroForm |
FormFieldType | Enum para tipos de campo (Text, Password, Textarea, Checkbox, Radio, Listbox, Combobox, Button) |
Navigation
Pacote: tcpdf-next/navigation
| Classe | Descrição |
|---|---|
BookmarkManager | Cria e aninha entradas de contorno do documento |
AnnotationManager | Adiciona anotações de marcação (highlight, note, underline) |
FileAttachment | Incorpora anexos de arquivo no documento |
TocManager | Geração automática de sumário |
Barcode
Pacote: tcpdf-next/barcode
| Classe | Descrição |
|---|---|
BarcodeGenerator | Fábrica unificada para todos os tipos de código de barras |
BarcodeType | Enum para códigos de barras 1D (CODE_39, CODE_128, EAN_13, ...) |
Barcode2DType | Enum para códigos de barras 2D (QR_CODE, DATAMATRIX, PDF417) |
Security
Pacote: tcpdf-next/security
| Classe | Descrição |
|---|---|
Aes256Encryptor | Criptografia AES-256 com handler AESV3 |
DigitalSigner | Criação de assinatura digital PAdES |
TsaClient | Cliente RFC 3161 Time Stamping Authority |
LtvManager | Long-Term Validation via DSS, OCSP stapling e incorporação de CRL |
DssBuilder | Constrói o dicionário Document Security Store |
Archive
Pacote: tcpdf-next/archive
| Classe | Descrição |
|---|---|
PdfAManager | Aplicação e validação de conformidade PDF/A-4 |
XmpMetadata | Gera pacotes de metadados XMP (ISO 16684) |
OutputIntent | Gerencia perfis de output intent ICC |
Accessibility
Pacote: tcpdf-next/accessibility
| Classe | Descrição |
|---|---|
StructureTreeManager | Gerencia a árvore de estrutura do PDF com tags |
RoleMap | Mapeia tags personalizadas para tipos de estrutura PDF padrão |
Writer
Pacote: tcpdf-next/writer
| Classe | Descrição |
|---|---|
PdfWriter | Orquestra saída binária PDF a partir do registro de objetos |
Linearizer | Produz saída PDF linearizada (otimizada para web) |
Laravel
Pacote: tcpdf-next/laravel
| Classe | Descrição |
|---|---|
TcpdfServiceProvider | Registra bindings e publica config |
Pdf (Facade) | Facade estática para Document::createStandalone() |
PdfResponse | Retorna um PDF como resposta HTTP do Laravel |
GeneratePdfJob | Job enfileirável para geração de PDF em background |
Symfony
Pacote: tcpdf-next/symfony
| Classe | Descrição |
|---|---|
TcpdfNextBundle | Registro do bundle Symfony e configuração de serviços |
PdfFactory | Fábrica compatível com DI para criar documentos PDF |
PdfResponse | Retorna um PDF como resposta HTTP do Symfony |
GeneratePdfMessage | Mensagem Messenger para geração assíncrona de PDF |
CodeIgniter
Pacote: tcpdf-next/codeigniter
| Classe | Descrição |
|---|---|
TcpdfNextService | Registro de serviço CodeIgniter |
PdfLibrary | Classe Library para uso em controladores CodeIgniter |
PdfResponse | Retorna um PDF como resposta HTTP do CodeIgniter |
GeneratePdfJob | Job de fila para geração de PDF em background |
Artisan
Pacote: tcpdf-next/artisan
| Classe | Descrição |
|---|---|
HtmlRenderer | Renderiza templates Blade / HTML para PDF via Chrome CDP |
ChromeBridge | Integração com Chrome headless para renderização pixel-perfect |
RenderOptions | DTO de configuração para comandos de renderização Artisan |
Adaptation
Pacote: tcpdf-next/adaptation
| Classe | Descrição |
|---|---|
TCPDF | Classe adaptadora non-final mapeando 252 métodos legados TCPDF para TCPDF-Next |
TCPDF_STATIC | Camada de compatibilidade de auxiliares estáticos |
TCPDF_FONTS | Camada de compatibilidade de auxiliares de fontes |
TCPDF_COLORS | Camada de compatibilidade de auxiliares de cores |
TCPDF_IMAGES | Camada de compatibilidade de auxiliares de imagens |
Leitura Adicional
- API do Document -- Todos os métodos públicos da classe
Document - Referência de Enums -- Todos os 22 enums com valores e uso
- Referência de Interfaces -- Interfaces de contrato para DI e testes
- API de Value Objects -- Métodos de fábrica, propriedades e conversões