class final Core · roukmoute/pdf 0.6.2
PDF\Specification\Dictionary\CollectionSortDictionaryTable158\SEntryTable 158, /S; PDF type: name or array; Required.Inheritance and contracts
Parent : PDF\Specification\SchemaEntry
Definition in the specification
Table 158 · Entries in a collection sort dictionary
ISO 32000-1:2008, §12.3.5 · PDF page 381 ↗
/S name or array
(Required) The name or names of fields that the conforming reader shall use to sort the items in the collection. If the value is a name, it identifies a field described in the parent collection dictionary. If the value is an array, each element of the array shall be a name that identifies a field described in the parent collection dictionary. The array form shall be used to allow additional fields to contribute to the sort, where each additional field shall be used to break ties. More specifically, if multiple collection item dictionaries have the same value for the first field named in the array, the values for successive fields named in the array shall be used for sorting, until a unique order is determined or until the named fields are exhausted.
Qualifier: Required
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\Syntax\Object\ArrayType|PDF\Syntax\Object\IndirectReference $value)Inherited methods
3 methods from parents and contracts
definition()
public function definition(): PDF\Specification\EntryDefinitionkey()
public function key(): PDF\Syntax\Object\NameTypevalue()
public function value(): PDF\Syntax\FileStructure\BasicTypeProperties
| Declaration | Origin and documentation |
|---|---|
public readonly PDF\Syntax\Object\NameType $key | PDF\Syntax\Object\DictionaryObject\Entry |
public readonly PDF\Syntax\FileStructure\BasicType $value | PDF\Syntax\Object\DictionaryObject\Entry |
Constants
| Name | PHP value | Origin |
|---|---|---|
KEY | | PDF\Specification\Dictionary\CollectionSortDictionaryTable158\SEntry |
TABLE | | PDF\Specification\Dictionary\CollectionSortDictionaryTable158\SEntry |
VARIABLE | | PDF\Specification\SchemaEntry |