class final Core · roukmoute/pdf 0.6.2
PDF\Graphics\OptionalContent\ConfigurationCoupled configuration declarations; all referenced OCGs are checked against their document.Inheritance and contracts
Parent : PDF\Specification\SchemaDictionary
Interfaces : Countable, IteratorAggregate, PDF\Syntax\FileStructure\BasicType, Stringable, Traversable
Definition in the specification
Table 101 · Entries in an Optional Content Configuration Dictionary
ISO 32000-1:2008, §8.11.4.3 · PDF page 237 ↗
| Entry | PDF type | Source requirement | Table |
|---|---|---|---|
/Name | text string | Optional | 101 |
/Creator | text string | Optional | 101 |
/BaseState | name | Optional | 101 |
/ON | array | Optional | 101 |
/OFF | array | Optional | 101 |
/Intent | name or array | Optional | 101 |
/AS | array | Optional | 101 |
/Order | array | Optional | 101 |
/ListMode | name | Optional | 101 |
/RBGroups | array | Optional | 101 |
/Locked | array | Optional; PDF 1.6 | 101 |
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\BaseState $baseState = PDF\Graphics\OptionalContent\BaseState::On, PDF\Graphics\OptionalContent\GroupCollection $on = new GroupCollection(), PDF\Graphics\OptionalContent\GroupCollection $off = new GroupCollection(), PDF\Graphics\OptionalContent\Intents $intents = new Intents(Intent::View), ?PDF\Graphics\OptionalContent\GroupOrder $order = null, ?PDF\Graphics\OptionalContent\RadioButtonGroups $radioGroups = null, PDF\Graphics\OptionalContent\GroupCollection $locked = new GroupCollection(), PDF\Graphics\OptionalContent\ListMode $listMode = PDF\Graphics\OptionalContent\ListMode::AllPages, ?PDF\Syntax\DataStructure\TextString $name = null, ?PDF\Syntax\DataStructure\TextString $creator = null, array $applications = [])@param list<UsageApplication> $applicationsDeclared methods
referencedGroups()
public function referencedGroups(): PDF\Graphics\OptionalContent\GroupCollectionvalidateDefault()
public function validateDefault(): 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
Constants
| Name | PHP value | Origin |
|---|---|---|
COMMON_TABLES | | PDF\Specification\SchemaDictionary |
TABLE | | PDF\Graphics\OptionalContent\Configuration |