class final Core · roukmoute/pdf 0.6.1

PDF\Document\Collections\CollectionField
Table157/page380: native data type and presentation facts for one collection field.

Read the source declaration ↗

Inheritance and contracts

Parent : PDF\Specification\SchemaDictionary

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

Traits : PDF\Document\Collections\CollectionVersion

Definition in the specification

Table 157 · Entries in a collection field dictionary
ISO 32000-1:2008, §12.3.5 · PDF page 380 ↗

EntryPDF typeSource requirementTable
/TypenameOptional157
/SubtypenameRequired157
/Ntext stringRequired157
/OintegerOptional157
/VbooleanOptional157
/EbooleanOptional157

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\CollectionFieldType $type, PDF\Syntax\DataStructure\TextString $displayName, ?PDF\Syntax\Object\IntegerType $order = null, PDF\Syntax\Object\BooleanType $visible = new BooleanType(true), PDF\Syntax\Object\BooleanType $editable = new BooleanType(false))

Declared by PDF\Document\Collections\CollectionField · View the code ↗

Declared methods

accepts()

public function accepts(PDF\Syntax\FileStructure\BasicType $value): bool

Declared by PDF\Document\Collections\CollectionField · View the code ↗

validateVersion()

public function validateVersion(PDF\Syntax\FileStructure\EffectivePdfVersion $version): void

Declared by PDF\Document\Collections\CollectionField · View the code ↗

with()

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

Declared by PDF\Document\Collections\CollectionField · View the code ↗

without()

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

Declared by PDF\Document\Collections\CollectionField · View the code ↗

Inherited methods

9 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 ↗

entries()

public function entries(): iterable
@return iterable<Entry>

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

get()

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 ↗

Properties

DeclarationOrigin and documentation
public readonly PDF\Document\Collections\CollectionFieldType $typePDF\Document\Collections\CollectionField

Constants