PDFToolkit object by object

Document structure

StructureTreeIndex

Reference / Document structure

class final readonly Core · roukmoute/pdf 0.6.2

PDF\Document\Structure\StructureTreeIndex
Validated, immutable derived indexes for one snapshot of the explicit hierarchy.

Read the source declaration ↗

Inheritance and contracts

This type declares no parent, interface or trait.

Construction

__construct()

public function __construct(array $elements, ?PDF\Syntax\DataStructure\NumberTree $parentTree, ?PDF\Syntax\DataStructure\NameTree $identifierTree, PDF\Syntax\Object\IntegerType $nextParentKey, array $containers, array $markedParents, array $objects, bool $hasUserProperties)
@param list<StructureElement> $elements
@param array<int, MarkedContentContainer> $containers
@param array<int, array<int, StructureElement>> $markedParents
@param list<ObjectReference> $objects

Declared by PDF\Document\Structure\StructureTreeIndex · View the code ↗

Properties

DeclarationOrigin and documentation
public readonly array $containersPDF\Document\Structure\StructureTreeIndex
public readonly array $elementsPDF\Document\Structure\StructureTreeIndex
public readonly bool $hasUserPropertiesPDF\Document\Structure\StructureTreeIndex
public readonly ?PDF\Syntax\DataStructure\NameTree $identifierTreePDF\Document\Structure\StructureTreeIndex
public readonly array $markedParentsPDF\Document\Structure\StructureTreeIndex
public readonly PDF\Syntax\Object\IntegerType $nextParentKeyPDF\Document\Structure\StructureTreeIndex
public readonly array $objectsPDF\Document\Structure\StructureTreeIndex
public readonly ?PDF\Syntax\DataStructure\NumberTree $parentTreePDF\Document\Structure\StructureTreeIndex