phpdftk API Documentation

StructElem extends PdfObject
in package
implements PdfVersionAware

PDF Structure Element (ISO 32000-2 Table 324).

Represents a node in the structure tree for tagged PDF.

Example: $elem = new StructElem('P'); $elem->p = new PdfReference($parent->objectNumber); $elem->t = new PdfString('Paragraph Title');

Attributes
#[RequiresPdfVersion]
\Phpdftk\Pdf\Core\PdfVersion::V1_3

Table of Contents

Interfaces

PdfVersionAware
Implemented by objects whose minimum PDF version depends on runtime state (e.g., a property value) rather than a static attribute.

Constants

PDF_TYPE  = 'StructElem'

Properties

$a  : PdfArray|null
$actualText  : PdfString|null
$alt  : PdfString|null
$c  : PdfArray|null
$e  : PdfString|null
$generationNumber  : int
$id  : PdfString|null
$k  : PdfReference|PdfArray|null
$lang  : PdfString|null
$objectNumber  : int
$p  : PdfReference|null
$pg  : PdfReference|null
$r  : int|null
$s  : PdfName
$t  : PdfString|null

Methods

__construct()  : mixed
getMinimumPdfVersion()  : PdfVersion|null
toIndirectObject()  : string
Wrap the object in an indirect object structure: X Y obj ... endobj
toPdf()  : string
Serialize the object's dictionary/value to PDF syntax.

Constants

Properties

$generationNumber

public int $generationNumber = 0

Methods

__construct()

public __construct(string $structureType) : mixed
Parameters
$structureType : string

toIndirectObject()

Wrap the object in an indirect object structure: X Y obj ... endobj

public toIndirectObject() : string
Return values
string

toPdf()

Serialize the object's dictionary/value to PDF syntax.

public toPdf() : string
Return values
string

        
On this page

Search results