phpdftk API Documentation

Writer

Table of Contents

Namespaces

Form

Classes

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().
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.

Enums

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

Search results