Skip to content

Referência de Enums

O TCPDF-Next usa PHP 8.1+ backed enums em toda a biblioteca para substituir constantes de string e inteiros com tipagem fraca. Esta página documenta cada enum, seus cases e uso típico.


Orientation

Namespace: TcpdfNext\Contracts\Orientation

Orientação da página.

CaseDescrição
PortraitMais alta que larga (padrão)
LandscapeMais larga que alta
php
use TcpdfNext\Contracts\Orientation;

$pdf->addPage(orientation: Orientation::Landscape);

Alignment

Namespace: TcpdfNext\Contracts\Alignment

Alinhamento horizontal de texto e conteúdo.

CaseDescrição
LeftAlinhar à margem esquerda
CenterCentralizar entre as margens
RightAlinhar à margem direita
JustifiedEsticar o texto para preencher toda a largura
php
use TcpdfNext\Contracts\Alignment;

$pdf->multiCell(width: 0, height: 10, text: $paragraph, align: Alignment::Justified);

OutputDestination

Namespace: TcpdfNext\Contracts\OutputDestination

Para onde enviar o PDF renderizado.

CaseDescrição
InlineEnviar ao navegador com Content-Disposition: inline
DownloadEnviar ao navegador com Content-Disposition: attachment
FileGravar em um arquivo no disco
StringRetornar o binário bruto como string
php
use TcpdfNext\Contracts\OutputDestination;

$binary = $pdf->output(OutputDestination::String);
$pdf->output(OutputDestination::File, path: '/reports/q4.pdf');

SignatureLevel

Namespace: TcpdfNext\Contracts\SignatureLevel

Nível de conformidade de assinatura digital PAdES conforme ETSI EN 319 142.

CaseDescrição
PAdES_B_BAssinatura básica com certificado de assinatura
PAdES_B_TAdiciona um timestamp RFC 3161 confiável
PAdES_B_LTAdiciona dados de validação (DSS, OCSP, CRL) para verificação de longo prazo
PAdES_B_LTAAdiciona um timestamp de arquivo para verificação indefinida
php
use TcpdfNext\Contracts\SignatureLevel;

$pdf->security()->sign(
    certFile: '/certs/signer.p12',
    password: 'secret',
    level: SignatureLevel::PAdES_B_LTA,
);

BlendMode

Namespace: TcpdfNext\Graphics\BlendMode

Modos de mesclagem de transparência PDF conforme ISO 32000-2 Seção 11.3.5.

CaseDescrição
NormalComposição padrão
MultiplyEscurece multiplicando cores
ScreenClareia invertendo, multiplicando e invertendo novamente
OverlayCombina Multiply e Screen baseado na cor base
DarkenSeleciona a mais escura entre cores base e de mesclagem
LightenSeleciona a mais clara entre cores base e de mesclagem
ColorDodgeClareia a cor base para refletir a cor de mesclagem
ColorBurnEscurece a cor base para refletir a cor de mesclagem
HardLightCombina Multiply e Screen baseado na cor de mesclagem
SoftLightEscurecimento ou clareamento sutil
DifferenceSubtrai a mais escura da mais clara
ExclusionSimilar a Difference com menor contraste
php
use TcpdfNext\Graphics\BlendMode;

$pdf->setAlpha(0.5, blendMode: BlendMode::Multiply);

BarcodeType

Namespace: TcpdfNext\Barcode\BarcodeType

Simbologias de código de barras 1D suportadas.

CaseDescrição
CODE_39Code 39 (alfanumérico)
CODE_39ECode 39 Extended (ASCII completo)
CODE_93Code 93
CODE_128Code 128 (troca automática de modo)
CODE_128ACode 128 subconjunto A
CODE_128BCode 128 subconjunto B
CODE_128CCode 128 subconjunto C (pares numéricos)
EAN_8EAN-8
EAN_13EAN-13
UPC_AUPC-A
UPC_EUPC-E
ITF_14ITF-14 (Interleaved 2 of 5)
CODABARCodabar
PHARMACODEPharmacode
MSIMSI Plessey
POSTNETPOSTNET (postal dos EUA)

Barcode2DType

Namespace: TcpdfNext\Barcode\Barcode2DType

Simbologias de código de barras 2D suportadas.

CaseDescrição
QR_CODEQR Code (ISO 18004) com correção de erro configurável (L/M/Q/H)
DATAMATRIXData Matrix ECC 200 (ISO 16022)
PDF417PDF417 (ISO 15438)
php
use TcpdfNext\Barcode\Barcode2DType;

$pdf->barcode2D('https://example.com', Barcode2DType::QR_CODE, w: 30, h: 30);

FormFieldType

Namespace: TcpdfNext\Form\FormFieldType

Tipos de campo AcroForm.

CaseDescrição
TEXTEntrada de texto de linha única
PASSWORDEntrada de texto senha (mascarada)
TEXTAREAEntrada de texto multi-linha
CHECKBOXToggle checkbox
RADIOBotão de rádio (parte de um grupo)
LISTBOXSeleção de lista com rolagem
COMBOBOXSeleção dropdown
BUTTONBotão push com ação JavaScript opcional

PdfAVersion

Namespace: TcpdfNext\Archive\PdfAVersion

Versões de conformidade PDF/A suportadas pelo TCPDF-Next.

CaseDescrição
A4PDF/A-4 (ISO 19005-4:2020) -- conformidade base
A4fPDF/A-4f -- permite arquivos incorporados
A4ePDF/A-4e -- permite conteúdo 3D e rich media
php
use TcpdfNext\Archive\PdfAVersion;

$pdf->archive()->enablePdfA(PdfAVersion::A4f);

FontType

Namespace: TcpdfNext\Typography\FontType

Tipos de formato de fonte suportados.

CaseDescrição
TrueTypeFontes TrueType (.ttf)
OpenTypeFontes OpenType (.otf, contornos CFF ou glyf)
Type1Fontes PostScript Type 1 (.pfb/.pfm)
CoreUma das 14 fontes padrão PDF (Base 14) -- incorporação não necessária

ColorSpace

Namespace: TcpdfNext\Graphics\ColorSpace

Identificadores de espaço de cor PDF.

CaseDescrição
DeviceRGBRed / Green / Blue (tela)
DeviceCMYKCyan / Magenta / Yellow / Key (impressão)
DeviceGrayEscala de cinza de canal único
SeparationCanal de cor spot nomeada
php
use TcpdfNext\Graphics\ColorSpace;

$color = Color::fromSpace(ColorSpace::DeviceCMYK, [100, 0, 0, 0]);

ObjectEntryType

Namespace: TcpdfNext\Core\ObjectEntryType

Classifica o tipo de objeto indireto PDF no ObjectRegistry.

Case
Catalog
Pages
Page
Font
FontDescriptor
Image
XObject
ExtGState
ColorSpace
Pattern
Shading
Annotation
Bookmark
AcroField
Signature
Metadata
OutputIntent
StructElement
Stream
Generic

AnnotationType

Namespace: TcpdfNext\Navigation\AnnotationType

Tipos de anotação de marcação conforme ISO 32000-2 Seção 12.5.6.

CaseDescrição
TextÍcone de nota adesiva
HighlightMarcação de destaque de texto
UnderlineMarcação de sublinhado de texto
StrikeOutMarcação de tachado de texto
SquigglyMarcação de sublinhado ondulado de texto
FreeTextChamada de texto inline

LineCapStyle

Namespace: TcpdfNext\Graphics\LineCapStyle

Estilos de ponta de linha conforme ISO 32000-2 Seção 8.4.3.3.

CaseValorDescrição
Butt0Ponta quadrada rente ao endpoint
Round1Ponta semicircular estendendo além do endpoint
Square2Ponta quadrada estendendo além do endpoint

LineJoinStyle

Namespace: TcpdfNext\Graphics\LineJoinStyle

Estilos de junção de linha conforme ISO 32000-2 Seção 8.4.3.4.

CaseValorDescrição
Miter0Canto afiado
Round1Canto arredondado
Bevel2Canto plano diagonal

TextDirection

Namespace: TcpdfNext\Typography\TextDirection

Direção de texto para renderização bidirecional (BiDi).

CaseDescrição
LeftToRightPadrão (LTR)
RightToLeftDireita para esquerda (Árabe, Hebraico)
AutoDetectar a partir do primeiro caractere forte

HashAlgorithm

Namespace: TcpdfNext\Security\HashAlgorithm

Algoritmos de digest usados em assinaturas e criptografia.

CaseDescrição
SHA256SHA-256 (padrão, recomendado)
SHA384SHA-384
SHA512SHA-512

PermissionFlag

Namespace: TcpdfNext\Security\PermissionFlag

Flags de permissão de documento para setProtection().

CaseDescrição
PrintPermitir impressão
PrintHighResPermitir impressão em alta resolução
ModifyPermitir modificação do documento
CopyPermitir extração de texto e imagens
AnnotFormsPermitir anotações e preenchimento de formulários
FillFormsPermitir apenas preenchimento de formulários
ExtractPermitir extração de texto para acessibilidade
AssemblePermitir inserção, rotação e exclusão de páginas

ErrorCorrectionLevel

Namespace: TcpdfNext\Barcode\ErrorCorrectionLevel

Níveis de correção de erro do QR Code conforme ISO 18004.

CaseCapacidade de Recuperação
Low~7%
Medium~15%
Quartile~25%
High~30%

Veja Também

Distribuído sob a licença LGPL-3.0-or-later.