class final Core · roukmoute/pdf 0.6.2
PDF\Graphics\OptionalContent\OptionalContentGroupOCG identity, immutable declaration and explicit document-scoped visibility.Inheritance and contracts
Parent : PDF\Specification\SchemaDictionary
Interfaces : Countable, IteratorAggregate, PDF\Document\CatalogComponent, PDF\Document\VersionedComponent, PDF\Graphics\OptionalContent\OptionalContentObject, PDF\Syntax\FileStructure\BasicType, Stringable, Traversable
Definition in the specification
Table 98 · Entries in an Optional Content Group Dictionary
ISO 32000-1:2008, §8.11.2.1 · PDF page 230 ↗
| Entry | PDF type | Source requirement | Table |
|---|---|---|---|
/Type | name | Required | 98 |
/Name | text string | Required | 98 |
/Intent | name or array | Optional | 98 |
/Usage | dictionary | Optional | 98 |
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\DataStructure\TextString $name, PDF\Graphics\OptionalContent\Intents $intents = new Intents(Intent::View), ?PDF\Graphics\OptionalContent\GroupUsage $usage = null)Declared methods
groups()
public function groups(): PDF\Graphics\OptionalContent\GroupCollectionvalidateCatalog()
public function validateCatalog(PDF\Syntax\Object\DictionaryType $catalog): voidvalidateVersion()
public function validateVersion(PDF\Syntax\FileStructure\EffectivePdfVersion $version): voidvisible()
public function visible(PDF\Graphics\OptionalContent\GroupStates $states): boolwith()
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 PDF\Graphics\OptionalContent\Intents $intents | PDF\Graphics\OptionalContent\OptionalContentGroup |
public readonly PDF\Syntax\DataStructure\TextString $name | PDF\Graphics\OptionalContent\OptionalContentGroup |
public readonly ?PDF\Graphics\OptionalContent\GroupUsage $usage | PDF\Graphics\OptionalContent\OptionalContentGroup |
Constants
| Name | PHP value | Origin |
|---|---|---|
COMMON_TABLES | | PDF\Specification\SchemaDictionary |
TABLE | | PDF\Graphics\OptionalContent\OptionalContentGroup |