class final Core · roukmoute/pdf 0.7.0
PDF\Document\Collections\CollectionTable155/pages378–379: container/initial-file selection and portable-collection presentation.Inheritance and contracts
Parent : PDF\Specification\SchemaDictionary
Interfaces : Countable, IteratorAggregate, PDF\Document\DocumentGraphComponent, PDF\Document\VersionedComponent, PDF\Syntax\FileStructure\BasicType, Stringable, Traversable
Definition in the specification
Table 155 · Entries in a collection dictionary
ISO 32000-1:2008, §12.3.5 · PDF page 379 ↗
| Entry | PDF type | Source requirement | Table |
|---|---|---|---|
/Type | name | Optional | 155 |
/Schema | dictionary | Optional | 155 |
/D | byte string | Optional | 155 |
/View | name | Optional | 155 |
/Sort | dictionary | Optional | 155 |
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 = null, PDF\Document\Collections\CollectionView $view = PDF\Document\Collections\CollectionView::Details, ?PDF\Syntax\Object\StringType $initialDocument = null, ?PDF\Document\Collections\CollectionSort $sort = null)Declared methods
catalogEntry()
public function catalogEntry(): PDF\Syntax\Object\DictionaryObject\EntryinitialFile()
public function initialFile(PDF\Document\DocumentGraphContext $graph): ?PDF\Syntax\FileStructure\BasicTypeNull selects the containing document, including the source-prescribed fallback for an invalid D.validateGraph()
public function validateGraph(PDF\Document\DocumentGraphContext $graph): voidvalidateVersion()
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.Constants
| Name | PHP value | Origin |
|---|---|---|
COMMON_TABLES | | PDF\Specification\SchemaDictionary |
TABLE | | PDF\Document\Collections\Collection |