Index

  1. \setasign\SetaPDF2
    1. Core
      1. Document
      2. Document
        1. Catalog
        2. Catalog
          1. AcroForm
          2. AdditionalActions
          3. Dests
          4. Extensions
          5. MarkInfo
          6. Names
          7. Names
          8. OptionalContent
          9. Outlines
          10. OutputIntents
          11. PageLabels
          12. Pages
          13. Permissions
          14. StructTreeRoot
          15. ViewerPreferences

setasign\SetaPDF2\Core\Document\Catalog

OptionalContent Class for handling optional content

File: /SetaPDF v2/Core/Document/Catalog/OptionalContent.php
Old class name (alias): \SetaPDF_Core_Document_Catalog_OptionalContent

Class hierarchy

Implements

Summary

Methods

Properties

Constants

Constants

STATE_OFF

public const string OptionalContent::STATE_OFF = 'OFF'

State constant

STATE_ON

public const string OptionalContent::STATE_ON = 'ON'

State constant

STATE_UNCHANGED

public const string OptionalContent::STATE_UNCHANGED = 'Unchanged'

State constant


Properties

$_catalog

protected \setasign\SetaPDF2\Core\Document\Catalog OptionalContent::$_catalog

The documents catalog instance

$_propertiesDictionary

protected \setasign\SetaPDF2\Core\Type\PdfDictionary OptionalContent::$_propertiesDictionary

The optional contents properties dictionary


Methods

__construct()

public OptionalContent::__construct ()

The constructor.

Parameters
$catalog : \setasign\SetaPDF2\Core\Document\Catalog
 

_getArrayFromDefaultViewing()

protected OptionalContent::_getArrayFromDefaultViewing (
string $name,
bool $create = false
): ?\setasign\SetaPDF2\Core\Type\PdfArray

Get and/or create an array entry in the default viewing dictionary.

Parameters
$name : string
 
$create : bool
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

_setOnOrOff()

protected OptionalContent::_setOnOrOff (): void
Parameters
$group : \setasign\SetaPDF2\Core\Document\OptionalContent\Group
 
$on : bool
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

addGroup()

public OptionalContent::addGroup (): \setasign\SetaPDF2\Core\Document\OptionalContent\Group

This method adds a method to the OCGs array.

By adding a group with this method the group will not be added to the user interface.

Parameters
$group : \setasign\SetaPDF2\Core\Document\OptionalContent\Group|string
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

addUsageApplication()

public OptionalContent::addUsageApplication (): void

Create and add usage application dictionaries for the given optional content group.

The usage definition in an optional content group will only apply to automatically adjustment if the group is referenced by a usage application dictionary.

$triangle = $optionalContent->appendGroup('Triangle');
// Define the usage
$triangle->usage()->setPrintState(\setasign\SetaPDF2\Core\Document\Catalog\OptionalContent::STATE_OFF);
// Now add it to an usage application dictionary
$optionalContent->addUsageApplication($triangle);
Parameters
$group : \setasign\SetaPDF2\Core\Document\OptionalContent\Group
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

See

appendGroup()

public OptionalContent::appendGroup (
string|\setasign\SetaPDF2\Core\Document\OptionalContent\Group $group,
?\setasign\SetaPDF2\Core\Document\OptionalContent\Group $parent = null,
?int $afterIndex = null,
string|\setasign\SetaPDF2\Core\Document\OptionalContent\Group $nextToOrLabel = null,
string $label = ''
): \setasign\SetaPDF2\Core\Document\OptionalContent\Group

Append an optional content group to the outline structure.

Parameters
$group : string|\setasign\SetaPDF2\Core\Document\OptionalContent\Group
 
$parent : ?\setasign\SetaPDF2\Core\Document\OptionalContent\Group
 
$afterIndex : ?int
 
$nextToOrLabel : string|\setasign\SetaPDF2\Core\Document\OptionalContent\Group
 
$label : string
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

cleanUp()

public OptionalContent::cleanUp (
void
): void

Release resources / cycled references.

getAsArray()

public OptionalContent::getAsArray (
bool $create = false
): ?\setasign\SetaPDF2\Core\Type\PdfArray

Get and/or create the AS array in the default viewing dictionary.

Parameters
$create : bool
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

See
  • PDF 32000-1:2008 - 8.11.4.3 Optional Content Configuration Dictionaries

getBaseState()

public OptionalContent::getBaseState (
void
): string

Get the base state from the default viewing dictionary.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

See
  • PDF 32000-1:2008 - 8.11.4.3 Optional Content Configuration Dictionaries

getDefaultViewingDictionary()

public OptionalContent::getDefaultViewingDictionary (
bool $create = false
): ?\setasign\SetaPDF2\Core\Type\PdfDictionary

Get the default viewing dictionary.

Parameters
$create : bool
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

See
  • PDF 32000-1:2008 - 8.11.4.2 Optional Content Properties Dictionary

getDocument()

public OptionalContent::getDocument (
void
): \setasign\SetaPDF2\Core\Document

Get the document instance.

getGroup()

public OptionalContent::getGroup (
string $name,
string $encoding = 'UTF-8'
): false|\setasign\SetaPDF2\Core\Document\OptionalContent\Group

Get a group by its name.

Parameters
$name : string

The group name

$encoding : string

The input encoding

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

getGroups()

public OptionalContent::getGroups (
void
): \setasign\SetaPDF2\Core\Document\OptionalContent\Group[]

Get all available content groups.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

getIterator()

public OptionalContent::getIterator (
void
): \setasign\SetaPDF2\Core\Document\OptionalContent\Iterator|\EmptyIterator

Implementation of IteratorAggregate.

A separate iterator is needed to receive \setasign\SetaPDF2\Core\Document\OptionalContent\Group objects while iterating.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

See

getOffArray()

public OptionalContent::getOffArray (
bool $create = false
): ?\setasign\SetaPDF2\Core\Type\PdfArray

Get and/or create the OFF array in the default viewing dictionary.

Parameters
$create : bool
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

See
  • PDF 32000-1:2008 - 8.11.4.3 Optional Content Configuration Dictionaries

getOnArray()

public OptionalContent::getOnArray (
bool $create = false
): ?\setasign\SetaPDF2\Core\Type\PdfArray

Get and/or create the ON array in the default viewing dictionary.

Parameters
$create : bool
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

See
  • PDF 32000-1:2008 - 8.11.4.3 Optional Content Configuration Dictionaries

getOptionalContentPropertiesDictionary()

public OptionalContent::getOptionalContentPropertiesDictionary (
bool $create = false
): ?\setasign\SetaPDF2\Core\Type\PdfDictionary

Get and creates the optional content properties dictionary.

Parameters
$create : bool
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

getOrderArray()

public OptionalContent::getOrderArray (
bool $create = false
): ?\setasign\SetaPDF2\Core\Type\PdfArray

Get and/or create the Order array in the default viewing dictionary.

Parameters
$create : bool
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

See
  • PDF 32000-1:2008 - 8.11.4.3 Optional Content Configuration Dictionaries

prependGroup()

public OptionalContent::prependGroup (
string|\setasign\SetaPDF2\Core\Document\OptionalContent\Group $group,
?\setasign\SetaPDF2\Core\Document\OptionalContent\Group $parent = null,
?int $beforeIndex = 0,
string|\setasign\SetaPDF2\Core\Document\OptionalContent\Group $nextToOrLabel = null,
string $label = ''
): \setasign\SetaPDF2\Core\Document\OptionalContent\Group

Prepends an optional content group to the outline structure.

If the $beforeIndex parameter is out of range the group will be appended.

Parameters
$group : string|\setasign\SetaPDF2\Core\Document\OptionalContent\Group
 
$parent : ?\setasign\SetaPDF2\Core\Document\OptionalContent\Group
 
$beforeIndex : ?int
 
$nextToOrLabel : string|\setasign\SetaPDF2\Core\Document\OptionalContent\Group
 
$label : string
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

setBaseState()

public OptionalContent::setBaseState (
string $baseState
): void

Set the base state in the default viewing dictionary.

Parameters
$baseState : string
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

See
  • PDF 32000-1:2008 - 8.11.4.3 Optional Content Configuration Dictionaries

setOff()

public OptionalContent::setOff (): void

Set the default state of the optional content group to off.

Parameters
$group : \setasign\SetaPDF2\Core\Document\OptionalContent\Group
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

setOn()

public OptionalContent::setOn (): void

Set the default state of the optional content group to on.

Parameters
$group : \setasign\SetaPDF2\Core\Document\OptionalContent\Group
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception


© 2025 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)