SetaPDF v2 API Reference

Index

\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

OptionalContent

Implements

Summary

Methods

__construct()
_getArrayFromDefaultViewing()
_setOnOrOff()
addGroup()
addUsageApplication()
appendGroup()
cleanUp()
getAsArray()
getBaseState()
getDefaultViewingDictionary()
getDocument()
getGroup()
getGroups()
getIterator()
getOffArray()
getOnArray()
getOptionalContentPropertiesDictionary()
getOrderArray()
prependGroup()
setBaseState()
setOff()
setOn()

Properties

$_catalog
$_propertiesDictionary

Constants

STATE_OFF
STATE_ON
STATE_UNCHANGED

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 \SetaPDF_Core_Document_Catalog OptionalContent::$_catalog

The documents catalog instance

$_propertiesDictionary

protected \SetaPDF_Core_Type_Dictionary OptionalContent::$_propertiesDictionary

The optional contents properties dictionary

Methods

__construct()

public OptionalContent::__construct (

\SetaPDF_Core_Document_Catalog $catalog

)

The constructor.

Parameters

$catalog : \SetaPDF_Core_Document_Catalog

_getArrayFromDefaultViewing()

protected OptionalContent::_getArrayFromDefaultViewing (

string $name,
bool $create = false

): ?\SetaPDF_Core_Type_Array

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 (

\SetaPDF_Core_Document_OptionalContent_Group $group,
bool $on = true

): void

Parameters

$group : \SetaPDF_Core_Document_OptionalContent_Group
$on : bool

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

addGroup()

public OptionalContent::addGroup (

\SetaPDF_Core_Document_OptionalContent_Group|string $group

): \SetaPDF_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 : \SetaPDF_Core_Document_OptionalContent_Group|string

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

addUsageApplication()

public OptionalContent::addUsageApplication (

\SetaPDF_Core_Document_OptionalContent_Group $group

): 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.

copy

$triangle = $optionalContent->appendGroup('Triangle');
// Define the usage
$triangle->usage()->setPrintState(\SetaPDF_Core_Document_Catalog_OptionalContent::STATE_OFF);
// Now add it to an usage application dictionary
$optionalContent->addUsageApplication($triangle);

Parameters

$group : \SetaPDF_Core_Document_OptionalContent_Group

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

See

\setasign\SetaPDF2\Core\Document\OptionalContent\Group\Usage

appendGroup()

public OptionalContent::appendGroup (

string|\SetaPDF_Core_Document_OptionalContent_Group $group,
?\SetaPDF_Core_Document_OptionalContent_Group $parent = null,
?int $afterIndex = null,
string|\SetaPDF_Core_Document_OptionalContent_Group $nextToOrLabel = null,
string $label = ''

): \SetaPDF_Core_Document_OptionalContent_Group

Append an optional content group to the outline structure.

Parameters

$group : string|\SetaPDF_Core_Document_OptionalContent_Group
$parent : ?\SetaPDF_Core_Document_OptionalContent_Group
$afterIndex : ?int
$nextToOrLabel : string|\SetaPDF_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

): ?\SetaPDF_Core_Type_Array

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

): ?\SetaPDF_Core_Type_Dictionary

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

): \SetaPDF_Core_Document

Get the document instance.

getGroup()

public OptionalContent::getGroup (

string $name,
string $encoding = 'UTF-8'

): false|\SetaPDF_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

): \SetaPDF_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

): \SetaPDF_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

\IteratorAggregate::getIterator()

getOffArray()

public OptionalContent::getOffArray (

bool $create = false

): ?\SetaPDF_Core_Type_Array

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

): ?\SetaPDF_Core_Type_Array

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

): ?\SetaPDF_Core_Type_Dictionary

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

): ?\SetaPDF_Core_Type_Array

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|\SetaPDF_Core_Document_OptionalContent_Group $group,
?\SetaPDF_Core_Document_OptionalContent_Group $parent = null,
?int $beforeIndex = 0,
string|\SetaPDF_Core_Document_OptionalContent_Group $nextToOrLabel = null,
string $label = ''

): \SetaPDF_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|\SetaPDF_Core_Document_OptionalContent_Group
$parent : ?\SetaPDF_Core_Document_OptionalContent_Group
$beforeIndex : ?int
$nextToOrLabel : string|\SetaPDF_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 (

\SetaPDF_Core_Document_OptionalContent_Group $group

): void

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

Parameters

$group : \SetaPDF_Core_Document_OptionalContent_Group

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

setOn()

public OptionalContent::setOn (

\SetaPDF_Core_Document_OptionalContent_Group $group

): void

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

Parameters

$group : \SetaPDF_Core_Document_OptionalContent_Group

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception