phpdftk API Documentation

phpdftk

Table of Contents

Interfaces

ColorInterface: Common contract for PDF color operands — used by ContentStream color operators.
CryptInterface: Symmetric cipher contract for PDF stream/string encryption.
TextEncoder: Converts a UTF-8 string into the byte sequence expected by a PDF font's encoding (e.g. WinAnsi).
FilterInterface: Symmetric encode/decode contract for PDF stream filters (ISO 32000-2 §7.4).
ConformanceConstraint: A single category of conformance checks (e.g. font embedding, encryption).
DocumentInspector: Abstract inspection interface for conformance validation.
ConformanceProfile: Represents a PDF subset conformance profile (e.g. PDF/A-1b, PDF/X-4, PDF/UA-1).
RegisteredFont: A font that has been registered with a writer and assigned a resource name. ContentStream::setFont() accepts this so callers can pass UTF-8 to showText() and have the encoder do the byte-level translation for them.
PdfVersionAware: Implemented by objects whose minimum PDF version depends on runtime state (e.g., a property value) rather than a static attribute.
Serializable: Contract for anything that can emit raw PDF syntax via `toPdf()`.
Source: Seekable byte source abstraction for the PDF tokenizer.

Classes

CmykColor: CMYK color with components in 0.0–1.0 range — maps to PDF DeviceCMYK.
ColorConverter: Lossless color model conversions between RGB, CMYK, and Gray.
GrayColor: Grayscale color (0.0 = black, 1.0 = white) — maps to PDF DeviceGray.
RgbColor: RGB color with components in 0.0–1.0 range — maps to PDF DeviceRGB.
AesCipher: AES-CBC cipher for PDF encryption (ISO 32000-2 §7.6.3).
PdfKeyDerivation: PDF encryption key derivation — ISO 32000-2 §7.6.
PublicKeyEncryption: Public-key (certificate-based) PDF encryption primitives — ISO 32000-2 §7.6.5.
Rc4Cipher: RC4 stream cipher for legacy PDF encryption (PDF 1.1–1.5).
SaslPrep: SASLprep password normalization — RFC 4013.
CMapParser
GlyphList
MacExpertEncodingTable: MacExpertEncoding — used by expert/small-caps Type 1 fonts on Mac.
MacRomanTable
PdfDocEncodingTable: PDFDocEncoding — the encoding for PDF text strings (Info dict, bookmarks, annotations) when they don't start with the UTF-16BE BOM (U+FEFF / 0xFE 0xFF).
PredefinedCMap: Predefined CMap names for CJK font encoding — ISO 32000-2 §9.7.5.
StandardEncodingTable: StandardEncoding — the default encoding for Type 1 fonts when no /Encoding is specified.
WinAnsiEncoder: Encodes UTF-8 strings to WinAnsi (single-byte, ISO 8859-1 + Microsoft additions in 0x80–0x9F) for use with Type1 standard fonts and any other font whose /Encoding is WinAnsiEncoding.
WinAnsiTable
Ascii85Filter: ASCII85Decode — base-85 encoding for binary data (ISO 32000-2 §7.4.3).
AsciiHexFilter: ASCIIHexDecode — hex encoding for binary data (ISO 32000-2 §7.4.2).
CCITTFaxFilter: CCITTFaxDecode filter — ITU-T T.4 (Group 3) and T.6 (Group 4) fax codec.
FlateFilter: FlateDecode — zlib/deflate compression (ISO 32000-2 §7.4.4).
Jbig2Filter: JBIG2Decode filter — ISO 14492 / ITU-T T.88 codec.
LzwFilter: LZW filter — decode/encode per ISO 32000-2 §7.4.4.2.
PredictorFilter: PDF predictor filter — applies/removes PNG and TIFF prediction as specified in ISO 32000-2 §7.4.4.4.
RunLengthFilter: RunLengthDecode — basic run-length encoding (ISO 32000-2 §7.4.5).
AfmData
StandardFontMetrics
CffData: Parsed CFF (Compact Font Format) table structure.
CffParser: Parses a CFF (Compact Font Format) binary table into a CffData structure.
CffSubsetter: Produces a minimal CFF table containing only requested glyphs.
GsubParser: Parses GSUB (Glyph Substitution) table for ligature features.
KerningParser: Parses kerning data from GPOS table (or legacy kern table).
OpenTypeData: Parsed OpenType CFF font data — metrics, glyph widths, and raw CFF bytes.
OpenTypeParser: Parser for OpenType fonts with CFF outlines (sfVersion "OTTO").
TextShaper: Simple text shaper for Latin ligature substitution.
TrueTypeData
TrueTypeParser
TrueTypeSubsetter: Produces a minimal valid TrueType font containing only requested glyphs.
Type1Data: Parsed data from a Type 1 font (PFB/PFA).
Type1Parser: Parses Type 1 font files (PFB binary and PFA ASCII formats).
Woff2Parser: WOFF 2.0 (Web Open Font Format 2.0) decompressor.
WoffParser: WOFF (Web Open Font Format 1.0) decompressor.
BezierCurve: Cubic Bézier curve — the primitive behind PDF path operators (c, v, y).
Matrix: Affine transformation matrix [a b c d e f].
PageSize: Standard page dimensions as Rectangles in PDF points (1/72 inch).
Point: 2D point in PDF user-space coordinates (1 unit = 1/72 inch).
Rectangle
GifParser: Parse GIF logical screen descriptor for dimensions and color info.
ImageInfo: Parsed image header metadata — everything needed to build a PDF ImageXObject without decoding pixel data.
ImageParser: Detect image format from magic bytes and delegate to the format-specific parser.
Jbig2Parser: Parse JBIG2 image headers.
Jpeg2000Parser: Parse JPEG 2000 (.jp2, .j2k, .j2c) image headers.
JpegParser: Parse JPEG headers (SOF marker) for dimensions, components, and color space.
PngParser: Parse PNG IHDR chunk for dimensions, bit depth, and color type.
TiffParser: Parse TIFF IFD tags for dimensions, color space, and bit depth.
WebpParser: Parse WebP container (RIFF/VP8/VP8L/VP8X) for dimensions and alpha.
ConformanceChecker: High-level conformance checker for existing PDFs.
ConformanceException: Thrown in strict mode when the document does not conform.
ConformanceMode: Value object holding the active conformance profile(s) and behavior mode.
ActionConstraint: PDF/A clause 6.5 / 6.6.1: Restricted action types.
AnnotationConstraint: PDF/UA-1 clause 7.18.1: Annotations must be accessible.
ColorSpaceConstraint: PDF/A clause 6.2: Device-dependent color spaces are only allowed when a matching OutputIntent is present.
DisplayDocTitleConstraint: PDF/UA-1 clause 7.18.1: ViewerPreferences /DisplayDocTitle must be true.
DPartRootConstraint: PDF/VT: Catalog must have a /DPartRoot reference.
EmbeddedFileConstraint: PDF/A-1 clause 6.9 / PDF/A-2 clause 6.10: Embedded files are prohibited.
EncryptionConstraint: PDF/A clause 6.6: Encryption is prohibited.
FilterConstraint: PDF/A-1 clause 6.8: LZWDecode filter is prohibited.
FontEmbeddingConstraint: PDF/A clause 6.3: All fonts must be embedded.
FormConstraint: Prohibits interactive forms (AcroForm).
MetadataConstraint: PDF/A clause 6.7: XMP metadata is required and must contain the conformance identification schema.
MultimediaConstraint: Prohibits multimedia content (movies, sounds, renditions, rich media).
OutputIntentConstraint: PDF/A clause 6.2.2: At least one OutputIntent with the correct subtype and an embedded ICC profile is required.
PdfEActionConstraint: ISO 24517-1 (PDF/E-1): Action restrictions.
PdfEColorSpaceConstraint: ISO 24517-1 (PDF/E-1): Color space validation.
PdfRActionConstraint: ISO 23504-1 (PDF/R-1): Action restrictions.
PdfRFontConstraint: ISO 23504-1 (PDF/R-1): Font presence warning.
RasterContentConstraint: ISO 23504-1 (PDF/R-1): Raster content validation.
ReferenceXObjectConstraint: ISO 15930-8/9 (PDF/X-5): Reference XObject validation.
TabOrderConstraint: PDF/UA-1 clause 7.5: Every page that contains annotations must have /Tabs set to /S (structure order).
TaggedStructureConstraint: Tagged structure requirements for PDF/A Level A and PDF/UA.
ThreeDContentConstraint: ISO 24517-1 (PDF/E-1): 3D content validation.
TransparencyConstraint: Transparency prohibition for PDF/A-1 (clause 6.4) and PDF/X-1a/X-3.
TrappedConstraint: PDF/X: The Info dictionary /Trapped key must be /True or /False.
TrimBoxConstraint: PDF/X: All pages must have /TrimBox (or /ArtBox as fallback).
ZugferdInvoiceConstraint: ZUGFeRD / Factur-X: Embedded invoice XML validation.
ZugferdXmpConstraint: ZUGFeRD / Factur-X: XMP metadata validation.
ReaderDocumentInspector: Inspects a parsed PDF (via PdfReader) for conformance validation.
WriterDocumentInspector: Inspects a PdfFileWriter's internal state for conformance validation.
ConformanceXmpWriter: Builds XMP metadata with the conformance identification schema.
ConformanceResult: The result of validating a document against a conformance profile.
ConformanceViolation: A single conformance violation detected during validation.
ConformanceValidator: Orchestrates conformance validation: runs all applicable constraints for a profile against a document inspector and returns a result.
ProfileConstraintRegistry: Maps each conformance profile to its set of applicable constraints.
Action: Abstract base class for all PDF action types (/Type /Action).
AdditionalActions: Additional-actions dictionary — ISO 32000-2 §12.6.3, Tables 194–197.
GoTo3DViewAction: Go-to-3D-view action (/S /GoTo3DView) — ISO 32000-2 §12.6.4.15.
GoToAction: GoTo action (/S /GoTo).
GoToDPAction: Go-to-document-part action (/S /GoToDP) — ISO 32000-2 §12.6.4.16.
GoToEAction: Go-to-embedded action (/S /GoToE) — ISO 32000-2 §12.6.4.4.
GoToRAction: GoToR action (/S /GoToR).
HideAction: Hide action (/S /Hide) — ISO 32000-2 §12.6.4.10.
ImportDataAction: Import-data action (/S /ImportData) — ISO 32000-2 §12.7.5.4.
JavaScriptAction: JavaScript action (/S /JavaScript).
LaunchAction: Launch action (/S /Launch) — ISO 32000-2 §12.6.4.5.
MovieAction: Movie action (/S /Movie) — ISO 32000-2 §12.6.4.9 (deprecated in 2.0 in favor of RichMedia, but still part of the spec).
NamedAction: Named action (/S /Named).
RenditionAction: Rendition action (/S /Rendition) — ISO 32000-2 §13.2.2.
ResetFormAction: Reset-form action (/S /ResetForm) — ISO 32000-2 §12.7.5.3.
RichMediaExecuteAction: Rich-media execute action (/S /RichMediaExecute) — ISO 32000-2 §13.6.9.
SetOCGStateAction: Set-OCG-state action (/S /SetOCGState) — ISO 32000-2 §12.6.4.12.
SoundAction: Sound action (/S /Sound) — ISO 32000-2 §12.6.4.8.
SubmitFormAction: Submit-form action (/S /SubmitForm) — ISO 32000-2 §12.7.5.2.
ThreadAction: Thread action (/S /Thread) — ISO 32000-2 §12.6.4.6.
TransAction: Transition action (/S /Trans) — ISO 32000-2 §12.6.4.14.
URIAction: URI action (/S /URI).
Annotation: Abstract base class for all PDF annotation types (/Type /Annot).
AppearanceCharacteristics: PDF Widget annotation appearance characteristics (ISO 32000-2 Table 192).
AppearanceDict: PDF Appearance dictionary (ISO 32000-2 Table 170).
BorderEffect: PDF Border Effect dictionary (/BE).
BorderStyle: PDF Border Style dictionary (/Type /Border).
CaretAnnotation: Caret annotation (/Subtype /Caret).
CircleAnnotation: Circle annotation (/Subtype /Circle).
FileAttachmentAnnotation: FileAttachment annotation (/Subtype /FileAttachment).
FreeTextAnnotation: Free text annotation (/Subtype /FreeText).
HighlightAnnotation: Highlight annotation (/Subtype /Highlight).
InkAnnotation: Ink annotation (/Subtype /Ink).
LineAnnotation: Line annotation (/Subtype /Line).
LinkAnnotation: Link annotation (/Subtype /Link).
MarkupAnnotation: Shared base for markup annotations — ISO 32000-2 §12.5.6.2, Table 170.
MovieAnnotation: Movie annotation (/Subtype /Movie).
PolygonAnnotation: Polygon annotation (/Subtype /Polygon).
PolyLineAnnotation: PolyLine annotation (/Subtype /PolyLine).
PopupAnnotation: Popup annotation (/Subtype /Popup).
PrinterMarkAnnotation: PrinterMark annotation (/Subtype /PrinterMark).
ProjectionAnnotation: Projection annotation (/Subtype /Projection).
RedactAnnotation: Redact annotation (/Subtype /Redact).
RichMediaAnnotation: RichMedia annotation (/Subtype /RichMedia).
ScreenAnnotation: Screen annotation (/Subtype /Screen).
SoundAnnotation: Sound annotation (/Subtype /Sound).
SquareAnnotation: Square annotation (/Subtype /Square).
SquigglyAnnotation: Squiggly annotation (/Subtype /Squiggly).
StampAnnotation: Stamp annotation (/Subtype /Stamp).
StrikeOutAnnotation: StrikeOut annotation (/Subtype /StrikeOut).
TextAnnotation: Text annotation (/Subtype /Text) - a "sticky note" annotation.
ThreeDAnnotation: 3D annotation (/Subtype /3D).
TrapNetAnnotation: TrapNet annotation (/Subtype /TrapNet).
UnderlineAnnotation: Underline annotation (/Subtype /Underline).
WatermarkAnnotation: Watermark annotation (/Subtype /Watermark).
WidgetAnnotation: Widget annotation (/Subtype /Widget).
ContentStream: Content stream for page graphics and text.
Resources: Resource dictionary used by Page and FormXObject.
DeprecatedPdfFeature: Marks a PDF object class or property as deprecated in the PDF specification.
Bead: Article bead dictionary (ISO 32000-2 Table 161).
BoxColorInfo: Box color information dictionary — ISO 32000-2 §14.11.2.2, Table 336.
BoxStyle: Box-style dictionary — ISO 32000-2 §14.11.2.3, Table 337.
Catalog: PDF Document Catalog (/Type /Catalog).
ClassMap: ClassMap dictionary — ISO 32000-2 §14.7.4.
Collection: PDF Collection dictionary (ISO 32000-2 Table 152).
CollectionItem: PDF Collection Item dictionary.
CollectionSchema: PDF Collection Schema dictionary.
CrossReferenceStream: Cross-reference stream (/Type /XRef) — ISO 32000-2 §7.5.8.
Destination: Explicit destination array (ISO 32000-2 Table 148).
DPart: Document part node (/Type /DPart) — ISO 32000-2 §14.12.
DPartRoot: Document parts root (/Type /DPartRoot) — ISO 32000-2 §14.12.
DSS: Document security store — ISO 32000-2 §12.8.4.3.
DssBuilder: Builder for the Document Security Store (DSS) — ISO 32000-2 §12.8.4.3.
GroupAttributes: Transparency group attributes dictionary (ISO 32000-2).
HintStream: Primary hint stream — ISO 32000-2 §F.3.1.
Info: PDF Document Information Dictionary.
LinearizationParameters: Linearization parameter dictionary — ISO 32000-2 §F.2.1.
MarkInfo: PDF MarkInfo dictionary.
MetadataStream: XMP metadata stream (/Type /Metadata /Subtype /XML) — ISO 32000-2 §14.3.2, Table 339.
NamesDictionary: Document Names dictionary — ISO 32000-2 §7.7.4, Table 33.
NameTree: General-purpose name-keyed tree node (ISO 32000-2 Table 36).
NumberTree: General-purpose integer-keyed tree node (ISO 32000-2 Table 37).
ObjectRef: PDF Object Reference dictionary (ISO 32000-2 Table 326).
ObjectStream: Object stream (/Type /ObjStm) — ISO 32000-2 §7.5.7.
OCConfig: Optional content configuration dictionary — ISO 32000-2 §8.11.4.3, Table 101.
OCG: PDF Optional Content Group (ISO 32000-2 Table 96).
OCMD: PDF Optional Content Membership Dictionary (ISO 32000-2 Table 97).
OCPropertiesDict: PDF Optional Content Properties Dictionary (ISO 32000-2 Table 100).
OCUsage: Optional content usage dictionary — ISO 32000-2 §8.11.4.4, Table 104.
Outline: PDF Outlines dictionary (/Type /Outlines).
OutlineItem: PDF Outline Item (bookmark entry).
OutputIntent: PDF Output Intent dictionary (ISO 32000-2 Table 365).
Page: PDF Page object (/Type /Page).
PageLabel: PDF Page Label dictionary (/Type /PageLabel).
PageTree: PDF Page Tree node (/Type /Pages).
Requirement: Requirement dictionary — ISO 32000-2 §12.10, Table 253.
RequirementHandler: Requirement handler dictionary (/Type /ReqHandler) — ISO 32000-2 §12.10, Table 254.
RoleMap: RoleMap dictionary — ISO 32000-2 §14.7.3.
StandardStructureType: Standard structure types — ISO 32000-2 §14.8.4.
LayoutAttribute: Layout attribute object (owner /Layout) — ISO 32000-2 §14.8.5.4.
ListAttribute: List attribute object (owner /List) — ISO 32000-2 §14.8.5.5.
PrintFieldAttribute: PrintField attribute object (owner /PrintField) — ISO 32000-2 §14.8.5.6.
TableAttribute: Table attribute object (owner /Table) — ISO 32000-2 §14.8.5.7.
StructAttribute: Structure attribute object — ISO 32000-2 §14.7.5.
StructElem: PDF Structure Element (ISO 32000-2 Table 324).
StructTreeRoot: PDF Structure Tree Root (ISO 32000-2 Table 323).
Thread: Article thread dictionary (ISO 32000-2 Table 160).
TransitionDict: PDF Page Transition dictionary (/Type /Trans).
ViewerPreferences: PDF Viewer Preferences dictionary.
BitWriter: Writes variable-width bit fields to a binary buffer.
CeilingVersionException: Thrown when ceiling version mode is active and an object's class-level version requirement exceeds the ceiling. Property-level incompatibilities are stripped silently; class-level ones cannot be.
CrossReferenceTable: Builds the classic PDF cross-reference table (ISO 32000-2 section 7.5.4).
DeprecatedFeatureException: Thrown when strict deprecation mode (or ceiling mode) is active and a feature marked with {@see DeprecatedPdfFeature::$removedIn} is registered at or above its removal version.
IncrementalWriter: Incremental update writer — ISO 32000-2 §7.5.6.
ObjectRegistry: Tracks all PdfObject instances and assigns sequential object numbers.
PdfFileWriter: Byte-level PDF file emitter — ISO 32000-2 §7.5.
PdfHydrator: Hydrates raw `PdfDictionary` objects (from the reader) into typed `PdfObject` subclasses (used by the writer).
TrailerDictionary: Trailer dictionary — ISO 32000-2 §7.5.5, Table 17.
VersionRequirementException: Thrown when strict version mode is enabled and a registered object requires a higher PDF version than the document is configured for.
VersionRequirementResolver: Reads {@see RequiresPdfVersion} and {@see DeprecatedPdfFeature} attributes from PDF object classes via reflection, with static per-class caching.
EmbeddedFile: Embedded file stream (/Type /EmbeddedFile) — ISO 32000-2 §7.11.4.
EmbeddedFileParams: Embedded file parameters (`/Params` entry of an EmbeddedFile stream) — ISO 32000-2 §7.11.4 Table 43.
FileSpec: File specification dictionary (/Type /Filespec) — ISO 32000-2 §7.11.3.
CCITTFaxDecodeParams: CCITTFaxDecode parameters — ISO 32000-2 §7.4.6, Table 11.
CryptFilterDecodeParams: Crypt filter /DecodeParms — ISO 32000-2 §7.4.10, Table 14.
DCTDecodeParams: DCTDecode (JPEG) parameters — ISO 32000-2 §7.4.8, Table 13.
FlateDecodeParams: FlateDecode / LZWDecode predictor parameters — ISO 32000-2 §7.4.4.3, Table 8. Inline-serialized into a stream's /DecodeParms.
JBIG2DecodeParams: JBIG2Decode parameters — ISO 32000-2 §7.4.7, Table 12.
JPXDecodeParams: JPXDecode (JPEG 2000) parameters — ISO 32000-2 §7.4.9.
CIDFont: CIDFont dictionary (/Type /Font /Subtype /CIDFontType0 or /CIDFontType2).
CIDFontType0Font: CIDFontType0 — CID-keyed font backed by a Type 1 / CFF font program (ISO 32000-2 §9.7.4). Used as the descendant of a /Type0 font when the glyphs come from an OpenType CFF or bare CFF font program.
CIDFontType2Font: CIDFontType2 — CID-keyed font backed by a TrueType font program (ISO 32000-2 §9.7.4). Used as the descendant of a /Type0 font when the glyphs come from a TrueType or OpenType TTF font program.
CIDSystemInfo: CIDSystemInfo dictionary.
CMapStream: CMap stream (/Type /CMap) — ISO 32000-2 §9.7.5.4.
Encoding: Encoding object (/Type /Encoding).
Font: Base PDF Font object (/Type /Font).
FontDescriptor: Font Descriptor object (/Type /FontDescriptor).
CFFFontFile: CFF / Type 1C / CIDFontType0C font program stream — ISO 32000-2 §9.9, Table 124. Referenced from `FontDescriptor::$fontFile3`. The /Subtype entry distinguishes the flavor:
TrueTypeFontFile: TrueType font program stream — ISO 32000-2 §9.9, Table 124.
Type1FontFile: Type 1 font program stream — ISO 32000-2 §9.9, Table 124.
MMType1Font: Multiple Master Type 1 font (/Subtype /MMType1).
TrueTypeFont: TrueType font (/Subtype /TrueType).
Type0Font: Type 0 (composite) font (/Type /Font /Subtype /Type0).
Type0FontFactory: Factory that builds a complete Type 0 composite font stack from TrueType font data.
Type1Font: Type 1 font (/Subtype /Type1).
Type3Font: Type 3 font (/Subtype /Type3).
CalGray: CalGray color space — ISO 32000-2 §8.6.5.2.
CalRGB: CalRGB color space — ISO 32000-2 §8.6.5.3.
ColorSpace: Abstract base for PDF color spaces.
DeviceCMYK: DeviceCMYK color space.
DeviceGray: DeviceGray color space.
DeviceN: DeviceN color space — ISO 32000-2 §8.6.6.5.
DeviceRGB: DeviceRGB color space.
ICCBased: ICCBased color space — ISO 32000-2 §8.6.5.5.
Indexed: Indexed color space — ISO 32000-2 §8.6.6.3.
Lab: L*a*b* color space — ISO 32000-2 §8.6.5.4.
Pattern: Pattern color space — ISO 32000-2 §8.6.6.2.
Separation: Separation color space — ISO 32000-2 §8.6.6.4.
ExtGState: External Graphics State parameter dictionary (/Type /ExtGState).
Func: Abstract base for PDF function objects (ISO 32000-2 §7.10).
FunctionType0: Sampled function (FunctionType 0) — ISO 32000-2 §7.10.2.
FunctionType2: Exponential interpolation function (FunctionType 2) — ISO 32000-2 §7.10.3.
FunctionType3: Stitching function (FunctionType 3) — ISO 32000-2 §7.10.4.
FunctionType4: PostScript calculator function (FunctionType 4) — ISO 32000-2 §7.10.5.
HalftoneType1: Dictionary-based halftone (HalftoneType 1) — ISO 32000-2 §10.6.4.
HalftoneType10: Threshold array halftone stream (HalftoneType 10) — ISO 32000-2 §10.6.5.
HalftoneType16: Threshold array halftone stream (HalftoneType 16) — ISO 32000-2 §10.6.5.
HalftoneType5: Composite halftone (HalftoneType 5) — ISO 32000-2 §10.6.5.
HalftoneType6: Threshold array halftone stream (HalftoneType 6) — ISO 32000-2 §10.6.5.
ShadingPattern: Shading pattern (/Type /Pattern /PatternType 2) — ISO 32000-2 §8.7.3.4.
TilingPattern: Tiling pattern (/Type /Pattern /PatternType 1) — ISO 32000-2 §8.7.3.
MeshShading: Abstract base for stream-based shading types 4–7.
Shading: Abstract base for PDF shading dictionaries — ISO 32000-2 §8.7.4.
ShadingType1: Function-based shading (ShadingType 1) — ISO 32000-2 §8.7.4.5.2.
ShadingType2: Axial (linear gradient) shading (ShadingType 2) — ISO 32000-2 §8.7.4.5.3.
ShadingType3: Radial gradient shading (ShadingType 3) — ISO 32000-2 §8.7.4.5.4.
ShadingType4: Free-form Gouraud-shaded triangle mesh (ShadingType 4) — ISO 32000-2 §8.7.4.5.5.
ShadingType5: Lattice-form Gouraud-shaded triangle mesh (ShadingType 5) — ISO 32000-2 §8.7.4.5.6.
ShadingType6: Coons patch mesh (ShadingType 6) — ISO 32000-2 §8.7.4.5.7.
ShadingType7: Tensor-product patch mesh (ShadingType 7) — ISO 32000-2 §8.7.4.5.8.
SoftMask: Soft Mask dictionary (ISO 32000-2 Table 131).
FormXObject: Form XObject (/Subtype /Form) — ISO 32000-2 §8.10, Table 95.
ImageXObject: Image XObject (/Subtype /Image) — ISO 32000-2 §8.9.5, Table 89.
PostScriptXObject: PostScript XObject (/Subtype /PS).
AcroForm: Interactive form (AcroForm) dictionary.
AppearanceGenerator: Generates appearance streams for interactive form fields.
ButtonField: Button field (/FT /Btn) - covers push buttons, check boxes, and radio buttons.
ChoiceField: Choice field (/FT /Ch) - covers list boxes and combo boxes.
FdfReader: FDF (Forms Data Format) file reader — ISO 32000-2 §12.7.8.
FdfWriter: FDF (Forms Data Format) file writer — ISO 32000-2 §12.7.8.
Field: Base class for all interactive form field types.
FontContext: Carries font metadata needed to render custom (non-standard) fonts in form field appearance streams.
SeedValueDictionary: Seed value dictionary — ISO 32000-2 §12.7.5.5, Table 234.
SigFieldLock: Signature field lock dictionary — ISO 32000-2 §12.7.5.5, Table 233.
SignatureField: Signature field (/FT /Sig) — ISO 32000-2 §12.7.5.5.
TextField: Text field (/FT /Tx).
XfdfReader: XFDF (XML Forms Data Format) reader — ISO 32000-2 §12.7.8.
XfdfWriter: XFDF (XML Forms Data Format) writer — ISO 32000-2 §12.7.8.
CertificateUtils: X.509 certificate utilities for LTV signature support.
CrlClient: CRL (Certificate Revocation List) fetcher.
DocMDPTransformParams: DocMDP transform parameters — ISO 32000-2 §12.8.2.2, Table 254.
DocTimeStamp: Document-level timestamp signature (/Type /DocTimeStamp) — ISO 32000-2 §12.8.5 / PAdES Part 4.
FieldMDPTransformParams: FieldMDP transform parameters — ISO 32000-2 §12.8.2.4, Table 255.
IdentityTransformParams: Identity transform parameters — ISO 32000-2 §12.8.2.
OcspClient: OCSP (Online Certificate Status Protocol) client — RFC 6960.
Pkcs7Signer: PKCS#7 / CMS detached signer — ISO 32000-2 §12.8.3.3.
SignatureReference: Signature reference dictionary (/Type /SigRef) — ISO 32000-2 §12.8.1, Table 253. Referenced by /Reference on a SignatureValue; each entry names a transform method plus its params.
SignatureValue: Signature value dictionary (/Type /Sig) — ISO 32000-2 §12.8.1, Table 258.
TransformParams: Abstract base for signature transform parameter dictionaries — ISO 32000-2 §12.8.2.
TsaClient: RFC 3161 Time-Stamp Authority (TSA) HTTP client.
UR3TransformParams: UR3 (usage rights) transform parameters — ISO 32000-2 §12.8.2.3, Table 256.
MediaClip: Media clip object (/Type /MediaClip) — ISO 32000-2 §13.2.4.
MediaClipData: Media clip data (/Type /MediaClip /S /MCD) — ISO 32000-2 §13.2.4.2.
MediaClipSection: Media clip section (/Type /MediaClip /S /MCS) — ISO 32000-2 §13.2.4.3.
MediaCriteria: Media criteria dictionary (/Type /MediaCriteria) — ISO 32000-2 §13.2.3.6.
MediaPlayParams: Media play parameters (/Type /MediaPlayParams) — ISO 32000-2 §13.2.5.
MediaRendition: Media rendition (/Type /Rendition /S /MR) — ISO 32000-2 §13.2.3.3.
MediaScreenParams: Media screen parameters (/Type /MediaScreenParams) — ISO 32000-2 §13.2.5.
Movie: Movie dictionary — ISO 32000-2 §13.4 (deprecated in PDF 2.0 in favor of RichMedia, but still part of the spec and referenced by MovieAnnotation).
Navigator: Navigator (/Type /Navigator) — ISO 32000-2 §13.2.7.
Rendition: Rendition (/Type /Rendition) — ISO 32000-2 §13.2.3.
SelectorRendition: Selector rendition (/Type /Rendition /S /SR) — ISO 32000-2 §13.2.3.4.
Sound: Sound object (/Type /Sound) — ISO 32000-2 §13.3.
PdfArray: Represents a PDF array object: [ item1 item2 ... ]
PdfBoolean: Represents a PDF boolean object.
PdfDate: PDF date string helper — ISO 32000-2 §7.9.4.
PdfDictionary: Represents a PDF dictionary object: << /Key value ... >>
PdfName: Represents a PDF name literal, e.g. /MediaBox, /Type, /Font.
PdfNull: Represents the PDF null object.
PdfNumber: Represents a PDF numeric object (integer or real number).
PdfObject: Base class for PDF objects that live as indirect objects (`X Y obj ... endobj`).
PdfReference: Represents an indirect reference to another PDF object: X 0 R
PdfStream: Represents a PDF stream object: a dictionary + binary/text data.
PdfString: Represents a PDF literal string (text) or a hex string <hex>.
RequiresPdfVersion: Declares the minimum PDF version required by a class or property.
CryptFilter: Crypt filter dictionary — ISO 32000-2 §7.6.5, Table 25.
EncryptDictionary: Encryption dictionary (/Type /Encrypt) — ISO 32000-2 §7.6.
PdfEncryptor: Encrypts PDF objects for the Standard and Adobe.PubSec security handlers.
PublicKeyRecipient: Public-key recipient dictionary — ISO 32000-2 §7.6.5.3, Table 27.
ThreeDBackground: 3D background dictionary (/Type /3DBG) — ISO 32000-2 §13.6.5.
ThreeDCrossSection: 3D cross-section dictionary (/Type /3DCrossSection) — ISO 32000-2 §13.6.8.
ThreeDLightingScheme: 3D lighting scheme dictionary (/Type /3DLightingScheme) — ISO 32000-2 §13.6.7.
ThreeDMeasure: 3D measurement dictionary (/Type /3DMeasure) — ISO 32000-2 §13.6.4.6.
ThreeDNode: 3D node dictionary (/Type /3DNode) — ISO 32000-2 §13.6.4.5.
ThreeDRenderMode: 3D render mode dictionary (/Type /3DRenderMode) — ISO 32000-2 §13.6.6.
ThreeDStream: 3D stream (/Type /3D) — ISO 32000-2 §13.6.3.
ThreeDView: 3D view dictionary (/Type /3DView) — ISO 32000-2 §13.6.4.
InvalidPdfException: Thrown when the parser encounters structurally invalid PDF data that cannot be recovered (e.g. missing %PDF header, corrupt xref table, unresolvable /Root catalog).
UnsupportedFilterException: Thrown when a stream uses a filter the reader cannot decode (e.g. JBIG2 without the jbig2dec extension, or an unrecognized custom filter name).
ObjectResolver: Lazy-loading object cache. Resolves indirect references by seeking to the xref-recorded byte offset, parsing the object, decompressing any stream data, and caching the result.
BitReader: Reads variable-width bit fields from a binary buffer.
ContentStreamOp: A single content stream operation: zero or more operands followed by an operator keyword.
ContentStreamParser: Parses decoded content stream data into a sequence of operations.
HintTableParser: Parses the binary hint table data from linearized PDF hint streams.
ObjectParser: Recursive-descent PDF object parser.
ObjectScanner: Scans raw PDF bytes for indirect object definitions to reconstruct a cross-reference table when the normal xref is corrupted.
ObjectStreamParser: Unpacks objects stored inside a /Type /ObjStm stream — ISO 32000-2 §7.5.7.
PageHintEntry: A single entry from the page offset hint table — ISO 32000-2 §F.4.1.
PageOffsetHintTable: Parsed page offset hint table — ISO 32000-2 §F.4.1.
SharedObjectHintEntry: A single entry from the shared object hint table — ISO 32000-2 §F.4.2.
SharedObjectHintTable: Parsed shared object hint table — ISO 32000-2 §F.4.2.
StreamParser: Applies the filter pipeline from a stream dictionary's `/Filter` entry to decompress raw stream data.
XrefParser: Parses a classic cross-reference table and its trailer dictionary.
XrefStreamParser: Parses a cross-reference stream (/Type /XRef) — ISO 32000-2 §7.5.8.
PdfDecryptor: Decrypts PDF objects using the Standard security handler.
PdfReader: PDF reader — parses existing PDF files into the phpdftk object model.
PositionedTextExtractor: Extracts text with precise positioning from a PDF page.
TextExtractor: Extracts text content from a PDF page by interpreting content stream operators.
TextSpan: A positioned span of text extracted from a PDF page.
FileSource
StringSource: Tokenizer source backed by an in-memory string -- used by {@see \Phpdftk\Pdf\Reader\PdfReader::fromString()}.
Token: A single lexical token from the PDF byte stream, carrying its type, string value, and byte offset within the source.
Tokenizer: PDF tokenizer — converts a byte stream into a sequence of typed tokens.
XrefEntry: A single entry from the cross-reference table.
AnnotationFlattener: Flatten annotations into page content, making them non-interactive.
BookmarkEntry: A bookmark (outline item) for the toolkit API.
BookmarkEditor: Add, replace, read, or remove PDF bookmarks (outlines).
Permission: PDF permission flags — mirrors PdfEncryptor constants for convenience.
FieldInfo: Read-only snapshot of a form field's properties.
FormFiller: Fill interactive PDF form fields (AcroForm).
LtvSigner: Add LTV (Long-Term Validation) data to signed PDFs — PAdES B-LT profile.
MetadataEditor: Read and modify PDF document metadata (Info dictionary).
MetadataInfo: Read-only snapshot of a PDF's Info dictionary fields.
PageLabeler: Set page numbering labels on a PDF.
PageSelector: Selects which pages an operation applies to.
PageSlicer: Extract, reorder, remove, and split pages from a PDF.
PageTransformer: Transform page geometry — rotate, scale, and set page boxes.
PdfEncrypt: Apply, change, or remove encryption on existing PDFs.
PdfMerger: Combine multiple PDFs into one document.
PdfStamper: Add text overlays, watermarks, page numbers, headers and footers to PDFs.
RedactionArea: Defines an area on a page to redact.
ImageStampStyle: Style configuration for image and PDF stamps.
StampStyle: Style configuration for text stamps.
WatermarkStyle: Style configuration for watermark text.
TextBlock: A block of text extracted from a PDF page, grouped by font/size.
TextExtractor: Extract text from PDFs — per page, full document, or with search.
TextMatch: A single text search match within a PDF.
TextRedactor: Redact text or areas from PDF pages by drawing filled rectangles.
TextSearchResults: Collection of text search matches across a PDF document.
Action: Static factory for the most common PDF action types. Each method returns an `Action` subclass ready to be assigned to `Catalog::$openAction`, an annotation's `/A` entry, or a form field's `/AA` (additional actions) dict.
CalloutStyle: Per-call style overrides for {@see Pdf::addCallout()} / {@see Writer\Page::drawCallout()}.
DashPattern: Dash pattern for stroked paths.
Font: Opaque font handle returned by PdfWriter::addFont().
CheckboxOptions: Options for {@see \Phpdftk\Pdf\Writer\PdfDoc::addCheckbox()}.
ChoiceFieldOptions: Options for {@see \Phpdftk\Pdf\Writer\PdfDoc::addChoiceField()}.
TextFieldOptions: Options for {@see \Phpdftk\Pdf\Writer\PdfDoc::addTextField()}.
ListBlock: Bullet or numbered list of plain strings. Each item is rendered as one marker (bullet glyph or running number) followed by the wrapped item text.
ListRenderer: Renders {@see ListBlock} content into a {@see ContentStream}.
ListStyle: Styling for {@see ListBlock} rendering.
Page: Level 1 Page — spatial drawing surface with explicit coordinates.
PageContext: Context passed to per-page render hooks (header / footer / watermark).
PageDecorator: Holds the optional per-page render hooks registered on a {@see Pdf} document: header, footer, and watermark closures.
PathBuilder: Fluent builder for custom PDF paths.
Pdf: High-level PDF document builder — **zero PDF object-model knowledge required**.
PdfDoc: Level 2 — friendly API over the PDF document object model.
PdfWriter: Ergonomic PDF document builder.
SpotColor: Handle for a registered spot color. Bundles the colorant name with the {@see Separation} value object so {@see Writer\Page::useSpotColor()} can register it on a page under a stable resource name.
Table: Tabular data placed via `Pdf::addTable()` (flow) or `Writer\Page::drawTable()` (positioned).
TableRenderContext: Rendering context passed to {@see TableRenderer}. Bundles the body / header font handles plus their metrics so the renderer doesn't need to know how the caller resolved fonts.
TableRenderer: Renders {@see Table} content into a {@see ContentStream}. The renderer is stateless and reusable; pagination logic lives at the call site (`Pdf::addTable` measures each row and starts a new page when needed).
TableStyle: Styling for {@see Table} rendering. All fields have sensible defaults so `new TableStyle()` produces a readable table.
TextLayout: Shared text-layout primitives — greedy word wrapping and width measurement against AFM metrics. Used by `Pdf` and by the shared primitive renderers (`TableRenderer`, `ListRenderer`, etc.) so flow layout and explicit placement agree on geometry.
TextStyle: Per-call text styling override for {@see Pdf::addText()}.
Theme: Document-wide styling defaults for the high-level {@see Pdf} builder.
XmpPacket: Immutable bag of XMP metadata properties.
XmpReader: Parse XMP metadata packets from XML into {@see XmpPacket}.
XmpWriter: Serialize an {@see XmpPacket} into an XMP XML packet with `<?xpacket?>` wrapping.

Enums

PdfAProfile: PDF/A conformance profiles (ISO 19005).
PdfEProfile: PDF/E conformance profiles (ISO 24517).
PdfMailProfile: PDF/mail conformance profile (ISO 23053-2).
PdfRProfile: PDF/R conformance profiles (ISO 23504).
PdfUaProfile: PDF/UA conformance profiles (ISO 14289).
PdfVtProfile: PDF/VT conformance profiles (ISO 16612).
PdfXProfile: PDF/X conformance profiles (ISO 15930).
ZugferdProfile: ZUGFeRD / Factur-X conformance profiles.
ViolationSeverity: Severity levels for conformance violations.
StandardFont: Enum of the 14 standard PDF fonts guaranteed to be available in every viewer.
PdfVersion: PDF specification versions — ISO 32000-1 (1.x) and ISO 32000-2 (2.0).
TokenType: PDF lexical token types produced by the tokenizer -- one case per distinct syntactic element in the PDF file format (ISO 32000-2 S7.2).
EncryptionMethod: PDF encryption algorithms mapped to their encryption dictionary revisions.
FieldType: PDF interactive form field types (ISO 32000-2 Table 226).
LabelStyle: Page label numbering styles (ISO 32000-2 Table 163).
StampPosition: Predefined stamp positions on a page.
Alignment: Horizontal text alignment within the content column.
CalloutType: Built-in callout types for {@see Pdf::addCallout()} / {@see Writer\Page::drawCallout()}.
PageSize: Standard page sizes, expressed in PDF user units (points, 1/72 inch).

On this page

Table Of Contents
- Interfaces
- Classes
- Enums