class final Core · roukmoute/pdf 0.6.1
PDF\Graphics\OptionalContent\OptionalContentPropertiesComplete document group scope and configuration relationships (8.11.4.2).Inheritance and contracts
Parent : PDF\Specification\SchemaDictionary
Interfaces : Countable, IteratorAggregate, PDF\Document\CatalogComponent, PDF\Document\VersionedComponent, PDF\Syntax\FileStructure\BasicType, Stringable, Traversable
Definition in the specification
Table 100 · Entries in the Optional Content Properties Dictionary
ISO 32000-1:2008, §8.11.4.2 · PDF page 236 ↗
| Entry | PDF type | Source requirement | Table |
|---|---|---|---|
/OCGs | array | Required | 100 |
/D | dictionary | Required | 100 |
/Configs | array | Optional | 100 |
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\Graphics\OptionalContent\GroupCollection $groups, PDF\Graphics\OptionalContent\Configuration $default = new Configuration(), PDF\Graphics\OptionalContent\Configuration ...$alternatives)Declared methods
catalogEntry()
public function catalogEntry(): PDF\Syntax\Object\DictionaryObject\Entrystates()
public function states(): PDF\Graphics\OptionalContent\GroupStatesvalidateCatalog()
public function validateCatalog(PDF\Syntax\Object\DictionaryType $catalog): 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.Properties
| Declaration | Origin and documentation |
|---|---|
public readonly array $alternatives | PDF\Graphics\OptionalContent\OptionalContentProperties@var list<Configuration> |
public readonly PDF\Graphics\OptionalContent\Configuration $default | PDF\Graphics\OptionalContent\OptionalContentProperties |
public readonly PDF\Graphics\OptionalContent\GroupCollection $groups | PDF\Graphics\OptionalContent\OptionalContentProperties |
Constants
| Name | PHP value | Origin |
|---|---|---|
COMMON_TABLES | | PDF\Specification\SchemaDictionary |
TABLE | | PDF\Graphics\OptionalContent\OptionalContentProperties |