class final Core · roukmoute/pdf 0.6.2
PDF\Document\Structure\StructureElementDocument-scoped hierarchy builder; all P/K links derive from attached child objects.Inheritance and contracts
Parent : PDF\Specification\SchemaDictionary
Interfaces : Countable, IteratorAggregate, PDF\Syntax\FileStructure\BasicType, Stringable, Traversable
Definition in the specification
Table 323 · Entries in a structure element dictionary
ISO 32000-1:2008, §14.7.2 · PDF page 566 ↗
| Entry | PDF type | Source requirement | Table |
|---|---|---|---|
/Type | name | Optional | 323 |
/S | name | Required | 323 |
/P | dictionary | Required; shall be an indirect reference | 323 |
/ID | byte string | Optional | 323 |
/Pg | dictionary | Optional; shall be an indirect reference | 323 |
/K | (various) | Optional | 323 |
/A | (various) | Optional | 323 |
/C | name or array | Optional | 323 |
/R | integer | Optional | 323 |
/T | text string | Optional | 323 |
/Lang | text string | Optional; PDF 1.4 | 323 |
/Alt | text string | Optional | 323 |
/E | text string | Optional; PDF 1.5 | 323 |
/ActualText | text string | Optional; PDF 1.4 | 323 |
Conditional descriptions remain traceable. A definition alone does not implement a codec, a signature or every format mechanism. Read the coverage.
Construction
__construct()
public function __construct(PDF\Syntax\Object\NameType|PDF\Document\Structure\StandardStructureType $type, ?PDF\Syntax\DocumentStructure\PageTree\PageObject $page = null, ?PDF\Syntax\Object\StringType $identifier = null, ?PDF\Document\Structure\StructureAttributes $attributes = null, ?PDF\Document\Structure\AttributeClassAssociations $classes = null, PDF\Syntax\Object\IntegerType $revision = new IntegerType(0), PDF\Syntax\Object\DictionaryObject\Entry ...$entries)Declared methods
addKid()
public function addKid(self|PDF\Document\Structure\PageMarkedContent|PDF\Document\Structure\MarkedContentReference|PDF\Document\Structure\ObjectReference $child): selfattachTo()
public function attachTo(self|PDF\Document\Structure\StructureTreeRoot $parent): void@internal Attach only through the parent builder.entries()
public function entries(): iterablekids()
public function kids(): array@return list<StructureElement|PageMarkedContent|MarkedContentReference|ObjectReference>parent()
public function parent(): self|PDF\Document\Structure\StructureTreeRoot|nullroot()
public function root(): PDF\Document\Structure\StructureTreeRoottoPdf()
public function toPdf(PDF\Serialization\SerializationContext $context): stringwith()
public function with(PDF\Syntax\Object\DictionaryObject\Entry $entry): staticwithout()
public function without(PDF\Syntax\Object\NameType|string $key): staticInherited methods
7 methods from parents and contracts
__toString()
public function __toString(): stringcount()
public function count(): intdefinition()
public function definition(): PDF\Specification\TableDefinitionget()
public function get(PDF\Syntax\Object\NameType|string $key): ?PDF\Syntax\FileStructure\BasicTypegetIterator()
public function getIterator(): Traversablehas()
public function has(PDF\Syntax\Object\NameType|string $key): boolvalidate()
public function validate(): voidChecks unconditional requirements; conditional and inherited rules remain explicit.Properties
| Declaration | Origin and documentation |
|---|---|
public readonly ?PDF\Document\Structure\StructureAttributes $attributes | PDF\Document\Structure\StructureElement |
public readonly ?PDF\Document\Structure\AttributeClassAssociations $classes | PDF\Document\Structure\StructureElement |
public readonly ?PDF\Syntax\Object\StringType $identifier | PDF\Document\Structure\StructureElement |
public readonly ?PDF\Syntax\DocumentStructure\PageTree\PageObject $page | PDF\Document\Structure\StructureElement |
public readonly PDF\Syntax\Object\IntegerType $revision | PDF\Document\Structure\StructureElement |
public readonly PDF\Syntax\Object\NameType $type | PDF\Document\Structure\StructureElement |
Constants
| Name | PHP value | Origin |
|---|---|---|
COMMON_TABLES | | PDF\Specification\SchemaDictionary |
TABLE | | PDF\Document\Structure\StructureElement |