class final Core · roukmoute/pdf 0.6.2
PDF\Document\Navigation\PageLabelA range's numbering rule, ISO12.4.2/Table159, PDF pp382–383.Inheritance and contracts
Parent : PDF\Specification\SchemaDictionary
Interfaces : Countable, IteratorAggregate, PDF\Document\VersionedComponent, PDF\Syntax\FileStructure\BasicType, Stringable, Traversable
Construction
__construct()
public function __construct(?PDF\Document\Navigation\LabelNumbering $numbering = null, ?PDF\Syntax\DataStructure\TextString $prefix = null, PDF\Syntax\Object\IntegerType $start = new IntegerType(1))Declared methods
label()
public function label(PDF\Syntax\Object\IntegerType $offset, PDF\Document\Navigation\NavigationLimits $limits = new NavigationLimits()): PDF\Syntax\DataStructure\TextStringvalidateVersion()
public function validateVersion(PDF\Syntax\FileStructure\EffectivePdfVersion $version): voidwith()
public function with(PDF\Syntax\Object\DictionaryObject\Entry $entry): staticwithout()
public function without(PDF\Syntax\Object\NameType|string $key): staticInherited methods
9 methods from parents and contracts
__toString()
public function __toString(): stringcount()
public function count(): intdefinition()
public function definition(): PDF\Specification\TableDefinitionentries()
public function entries(): iterable@return iterable<Entry>get()
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): booltoPdf()
public function toPdf(PDF\Serialization\SerializationContext $context): stringvalidate()
public function validate(): voidChecks unconditional requirements; conditional and inherited rules remain explicit.Properties
| Declaration | Origin and documentation |
|---|---|
public readonly ?PDF\Document\Navigation\LabelNumbering $numbering | PDF\Document\Navigation\PageLabel |
public readonly ?PDF\Syntax\DataStructure\TextString $prefix | PDF\Document\Navigation\PageLabel |
public readonly PDF\Syntax\Object\IntegerType $start | PDF\Document\Navigation\PageLabel |
Constants
| Name | PHP value | Origin |
|---|---|---|
COMMON_TABLES | | PDF\Specification\SchemaDictionary |
TABLE | | PDF\Specification\SchemaDictionary |