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
PDF_TYPE
public
mixed
PDF_TYPE
= 'StructElem'
Properties
$a
public
PdfArray|null
$a
= null
$actualText
public
PdfString|null
$actualText
= null
$alt
public
PdfString|null
$alt
= null
$c
public
PdfArray|null
$c
= null
$e
public
PdfString|null
$e
= null
$generationNumber
public
int
$generationNumber
= 0
$id
public
PdfString|null
$id
= null
$k
public
PdfReference|PdfArray|null
$k
= null
$lang
public
PdfString|null
$lang
= null
$objectNumber
public
int
$objectNumber
= 0
$p
public
PdfReference|null
$p
= null
$pg
public
PdfReference|null
$pg
= null
$r
public
int|null
$r
= null
$s
public
PdfName
$s
$t
public
PdfString|null
$t
= null
Methods
__construct()
public
__construct(string $structureType) : mixed
Parameters
- $structureType : string
getMinimumPdfVersion()
public
getMinimumPdfVersion() : PdfVersion|null
Return values
PdfVersion|nulltoIndirectObject()
Wrap the object in an indirect object structure: X Y obj ... endobj
public
toIndirectObject() : string
Return values
stringtoPdf()
Serialize the object's dictionary/value to PDF syntax.
public
toPdf() : string