Skip to content

API Reference

Complete API reference for every package in the TCPDF-Next ecosystem. Each package is listed below with its key classes and interfaces. Click through to the dedicated pages for method signatures, parameters, and usage examples.

Core

Paket: tcpdf-next/core

ClassBeschreibung
DocumentCentral entry point -- fluent facade that delegates to 12 traits
ObjectRegistryTracks all PDF indirect objects and assigns unique object numbers
TransactionManagerSavepoint / rollback semantics for complex layout operations
CrossReferenceStreamBuilds the PDF 2.0 binary cross-reference stream

Contracts

Paket: tcpdf-next/contracts

Interface / EnumKindBeschreibung
PdfDocumentInterfaceInterfacePrimary API contract for any PDF document implementation
FontManagerInterfaceInterfaceFont loading, registration, and subsetting contract
SignerInterfaceInterfaceDigital signature provider abstraction
HsmSignerInterfaceInterfaceExtended signer for hardware security modules
OrientationEnumPage orientation (Portrait, Landscape)
AlignmentEnumText alignment (Left, Center, Right, Justified)
AusgabeDestinationEnumAusgabe target (Inline, Download, File, String)
SignatureLevelEnumPAdES conformance level (B-B through B-LTA)

Value Objects

Paket: tcpdf-next/value-objects

ClassBeschreibung
PageSizeNamed or custom page size with preset factories (A0 -- A6, Letter, Legal, Tabloid)
MarginFour-sided page margins (top, right, bottom, left)
PositionImmutable x--y coordinate
DimensionImmutable width--height pair
UnitUnit conversion helpers (mm, pt, cm, in)

Grafiken

Paket: tcpdf-next/graphics

ClassBeschreibung
ColorImmutable color representation (RGB, CMYK, Gray, Spot)
ColorSpaceEnum for DeviceRGB, DeviceCMYK, DeviceGray, Separation
BlendModeTransparency blend mode enum (Normal, Multiply, Screen, Overlay, ...)
LayerManagerOptional Content Group (OCG) management
GradientManagerLinear and radial gradient creation

Typography

Paket: tcpdf-next/typography

ClassBeschreibung
FontManagerCentral registry for loading and managing fonts
FontSubsetterCreates minimal font subsets containing only used glyphs
FontInfoReadonly data object exposing glyph metrics, ascender, descender
BiDiResolverUnicode Bidirectional Algorithm (UAX #9) implementation

Content

Paket: tcpdf-next/content

ClassBeschreibung
TextRendererHigh-level text rendering with shadows and effects
JavaScriptManagerEmbeds document-level JavaScript actions

Layout

Paket: tcpdf-next/layout

ClassBeschreibung
PageManagerTracks pages, handles page breaks, manages current page state
HeaderFooterManagerRepeating header and footer content management
ColumnManagerMulti-column content flow
BookletManagerImposes pages for saddle-stitch booklet printing

Html

Paket: tcpdf-next/html

ClassBeschreibung
HtmlParserParses HTML markup into a DOM tree for rendering
CssRuleRepresents a single resolved CSS rule with specificity
TableParserSpecialized parser for HTML table layout

Form

Paket: tcpdf-next/form

ClassBeschreibung
FormFieldManagerCreates and manages AcroForm fields
FormFieldTypeEnum for field types (Text, Password, Textarea, Checkbox, Radio, Listbox, Combobox, Button)

Paket: tcpdf-next/navigation

ClassBeschreibung
BookmarkManagerCreates and nests document outline entries
AnnotationManagerAdds markup annotations (highlight, note, underline)
FileAttachmentEmbeds file attachments in the document
TocManagerAutomatic table of contents generation

Barcode

Paket: tcpdf-next/barcode

ClassBeschreibung
BarcodeGeneratorUnified factory for all barcode types
BarcodeTypeEnum for 1D barcodes (CODE_39, CODE_128, EAN_13, ...)
Barcode2DTypeEnum for 2D barcodes (QR_CODE, DATAMATRIX, PDF417)

Sicherheit

Paket: tcpdf-next/security

ClassBeschreibung
Aes256EncryptorAES-256 encryption with AESV3 handler
DigitalSignerPAdES digital signature creation
TsaClientRFC 3161 Time Stamping Authority client
LtvManagerLong-Term Validation via DSS, OCSP stapling, and CRL embedding
DssBuilderBuilds the Document Sicherheit Store dictionary

Archive

Paket: tcpdf-next/archive

ClassBeschreibung
PdfAManagerPDF/A-4 conformance enforcement and validation
XmpMetadataGenerates XMP metadata packets (ISO 16684)
AusgabeIntentManages ICC output intent profiles

Accessibility

Paket: tcpdf-next/accessibility

ClassBeschreibung
StructureTreeManagerManages the tagged PDF structure tree
RoleMapMaps custom tags to standard PDF structure types

Writer

Paket: tcpdf-next/writer

ClassBeschreibung
PdfWriterOrchestrates binary PDF output from the object registry
LinearizerProduces linearized (web-optimized) PDF output

Laravel

Paket: tcpdf-next/laravel

ClassBeschreibung
TcpdfServiceProviderRegisters bindings and publishes config
Pdf (Facade)Static facade for Document::createStandalone()
PdfResponseReturns a PDF as a Laravel HTTP response
GeneratePdfJobQueueable job for background PDF generation

Symfony

Paket: tcpdf-next/symfony

ClassBeschreibung
TcpdfNextBundleSymfony bundle registration and service wiring
PdfFactoryDI-friendly factory for creating PDF documents
PdfResponseReturns a PDF as a Symfony HTTP response
GeneratePdfMessageMessenger message for async PDF generation

CodeIgniter

Paket: tcpdf-next/codeigniter

ClassBeschreibung
TcpdfNextServiceCodeIgniter service registration
PdfLibraryLibrary class for CodeIgniter controller usage
PdfResponseReturns a PDF as a CodeIgniter HTTP response
GeneratePdfJobQueue job for background PDF generation

Artisan

Paket: tcpdf-next/artisan

ClassBeschreibung
HtmlRendererRenders Blade / HTML templates to PDF via Chrome CDP
ChromeBridgeHeadless Chrome integration for pixel-perfect rendering
RenderOptionsKonfiguration DTO for Artisan render commands

Adaptation

Paket: tcpdf-next/adaptation

ClassBeschreibung
TCPDFNon-final adapter class mapping 252 legacy TCPDF methods to TCPDF-Next
TCPDF_STATICStatic helper compatibility layer
TCPDF_FONTSFont helper compatibility layer
TCPDF_COLORSColor helper compatibility layer
TCPDF_IMAGESImage helper compatibility layer

Further Reading

Veröffentlicht unter der LGPL-3.0-or-later Lizenz.