StructTreeRoot
extends PdfObject
in package
PDF Structure Tree Root (ISO 32000-2 Table 323).
Root of the structure tree for tagged PDF documents.
Example: $root = new StructTreeRoot(); $root->k = new PdfReference($rootElem->objectNumber); $root->roleMap = new PdfDictionary(['Figure' => new PdfName('Span')]);
Attributes
- #[RequiresPdfVersion]
- \Phpdftk\Pdf\Core\PdfVersion::V1_3
Table of Contents
Constants
- PDF_TYPE = 'StructTreeRoot'
Properties
- $classMap : ClassMap|PdfDictionary|null
- $generationNumber : int
- $idTree : PdfReference|null
- $k : PdfReference|PdfArray|null
- $objectNumber : int
- $parentTree : PdfReference|null
- $parentTreeNextKey : int|null
- $roleMap : RoleMap|PdfDictionary|null
Methods
- 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
= 'StructTreeRoot'
Properties
$classMap
public
ClassMap|PdfDictionary|null
$classMap
= null
$generationNumber
public
int
$generationNumber
= 0
$idTree
public
PdfReference|null
$idTree
= null
$k
public
PdfReference|PdfArray|null
$k
= null
$objectNumber
public
int
$objectNumber
= 0
$parentTree
public
PdfReference|null
$parentTree
= null
$parentTreeNextKey
public
int|null
$parentTreeNextKey
= null
$roleMap
public
RoleMap|PdfDictionary|null
$roleMap
= null
Methods
toIndirectObject()
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