PDFToolkit object by object

Document structure

DocumentCatalog

Reference / Document structure

class final Core · roukmoute/pdf 0.6.2

PDF\Syntax\DocumentStructure\DocumentCatalog
The document's catalog dictionary (ISO 32000-1, table 28).

Read the source declaration ↗

Inheritance and contracts

Parent : PDF\Specification\SchemaDictionary

Interfaces : Countable, IteratorAggregate, PDF\Syntax\FileStructure\BasicType, Stringable, Traversable

Definition in the specification

Table 28 · Entries in the catalog dictionary
ISO 32000-1:2008, §7.7.2 · PDF page 81 ↗

EntryPDF typeSource requirementTable
/TypenameRequired28
/VersionnameOptional; PDF 1.428
/ExtensionsdictionaryOptional; ISO 3200028
/PagesdictionaryRequired; shall be an indirect reference28
/PageLabelsnumber treeOptional; PDF 1.328
/NamesdictionaryOptional; PDF 1.228
/DestsdictionaryOptional; PDF 1.1; shall be an indirect reference28
/ViewerPreferencesdictionaryOptional; PDF 1.228
/PageLayoutnameOptional28
/PageModenameOptional28
/OutlinesdictionaryOptional; shall be an indirect reference28
/ThreadsarrayOptional; PDF 1.1; shall be an indirect reference28
/OpenActionarray or dictionaryOptional; PDF 1.128
/AAdictionaryOptional; PDF 1.428
/URIdictionaryOptional; PDF 1.128
/AcroFormdictionaryOptional; PDF 1.228
/MetadatastreamOptional; PDF 1.4; shall be an indirect reference28
/StructTreeRootdictionaryOptional; PDF 1.328
/MarkInfodictionaryOptional; PDF 1.428
/Langtext stringOptional; PDF 1.428
/SpiderInfodictionaryOptional; PDF 1.328
/OutputIntentsarrayOptional; PDF 1.428
/PieceInfodictionaryOptional; PDF 1.428
/OCPropertiesdictionaryOptional; PDF 1.5; required if a document contains optional content28
/PermsdictionaryOptional; PDF 1.528
/LegaldictionaryOptional; PDF 1.528
/RequirementsarrayOptional; PDF 1.728
/CollectiondictionaryOptional; PDF 1.728
/NeedsRenderingbooleanOptional; PDF 1.728

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\DocumentStructure\PageTree\PageTreeNode|PDF\Syntax\Object\IndirectReference $pages, PDF\Syntax\Object\DictionaryObject\Entry ...$entries)

Declared by PDF\Syntax\DocumentStructure\DocumentCatalog · View the code ↗

Declared methods

entries()

public function entries(): iterable

Declared by PDF\Syntax\DocumentStructure\DocumentCatalog · View the code ↗

with()

public function with(PDF\Syntax\Object\DictionaryObject\Entry $entry): static

Declared by PDF\Syntax\DocumentStructure\DocumentCatalog · View the code ↗

without()

public function without(PDF\Syntax\Object\NameType|string $key): static

Declared by PDF\Syntax\DocumentStructure\DocumentCatalog · View the code ↗

Inherited methods

8 methods from parents and contracts

__toString()

public function __toString(): string

Declared by PDF\Syntax\Object\DictionaryType · View the code ↗

count()

public function count(): int

Declared by PDF\Syntax\Object\DictionaryType · View the code ↗

definition()

public function definition(): PDF\Specification\TableDefinition

Declared by PDF\Specification\SchemaDictionary · View the code ↗

get()

public function get(PDF\Syntax\Object\NameType|string $key): ?PDF\Syntax\FileStructure\BasicType

Declared by PDF\Syntax\Object\DictionaryType · View the code ↗

getIterator()

public function getIterator(): Traversable

Declared by PDF\Syntax\Object\DictionaryType · View the code ↗

has()

public function has(PDF\Syntax\Object\NameType|string $key): bool

Declared by PDF\Syntax\Object\DictionaryType · View the code ↗

toPdf()

public function toPdf(PDF\Serialization\SerializationContext $context): string

Declared by PDF\Specification\SchemaDictionary · View the code ↗

validate()

public function validate(): void
Checks unconditional requirements; conditional and inherited rules remain explicit.

Declared by PDF\Specification\SchemaDictionary · View the code ↗

Constants

NamePHP valueOrigin
COMMON_TABLES
[]
PDF\Specification\SchemaDictionary
TABLE
'28'
PDF\Syntax\DocumentStructure\DocumentCatalog