class final Core · roukmoute/pdf 0.6.1
PDF\Document\Collections\CollectionSortTable158/page381: broadcast boolean, missing directions=true, extra directions ignored.Inheritance and contracts
Parent : PDF\Specification\SchemaDictionary
Interfaces : Countable, IteratorAggregate, PDF\Document\VersionedComponent, PDF\Syntax\FileStructure\BasicType, Stringable, Traversable
Definition in the specification
Table 158 · Entries in a collection sort dictionary
ISO 32000-1:2008, §12.3.5 · PDF page 381 ↗
| Entry | PDF type | Source requirement | Table |
|---|---|---|---|
/Type | name | Optional | 158 |
/S | name or array | Required | 158 |
/A | boolean or array | Optional | 158 |
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\Document\Collections\CollectionSchema $schema, PDF\Syntax\Object\NameType|PDF\Document\Collections\CollectionSortFields $fields, PDF\Syntax\Object\BooleanType|PDF\Document\Collections\CollectionSortDirections $ascending = new BooleanType(true))Declared methods
ascendingAt()
public function ascendingAt(int $index): boolvalidateVersion()
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\Syntax\Object\BooleanType|PDF\Document\Collections\CollectionSortDirections $ascending | PDF\Document\Collections\CollectionSort |
public readonly PDF\Syntax\Object\NameType|PDF\Document\Collections\CollectionSortFields $fields | PDF\Document\Collections\CollectionSort |
Constants
| Name | PHP value | Origin |
|---|---|---|
COMMON_TABLES | | PDF\Specification\SchemaDictionary |
TABLE | | PDF\Document\Collections\CollectionSort |