Index

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

SetaPDF_Core_Document_Catalog_OptionalContent Class for handling optional content

File: /SetaPDF v2/Core/Document/Catalog/OptionalContent.php

Class hierarchy

Implements

Summary

Methods

Properties

Constants

Constants

STATE_OFF

public const string SetaPDF_Core_Document_Catalog_OptionalContent::STATE_OFF = 'OFF'

State constant

STATE_ON

public const string SetaPDF_Core_Document_Catalog_OptionalContent::STATE_ON = 'ON'

State constant

STATE_UNCHANGED

public const string SetaPDF_Core_Document_Catalog_OptionalContent::STATE_UNCHANGED = 'Unchanged'

State constant


Properties

$_catalog

protected SetaPDF_Core_Document_Catalog SetaPDF_Core_Document_Catalog_OptionalContent::$_catalog

The documents catalog instance

$_propertiesDictionary

protected SetaPDF_Core_Type_Dictionary SetaPDF_Core_Document_Catalog_OptionalContent::$_propertiesDictionary

The optional contents properties dictionary


Methods

__construct()

public SetaPDF_Core_Document_Catalog_OptionalContent::__construct ()

The constructor.

Parameters
$catalog : SetaPDF_Core_Document_Catalog
 

_getArrayFromDefaultViewing()

protected SetaPDF_Core_Document_Catalog_OptionalContent::_getArrayFromDefaultViewing (
string $name [, boolean $create = false ]
): null|SetaPDF_Core_Type_Array

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

Parameters
$name : string
 
$create : boolean
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

_setOnOrOff()

protected SetaPDF_Core_Document_Catalog_OptionalContent::_setOnOrOff (
SetaPDF_Core_Document_OptionalContent_Group $group [, bool $on = true ]
): void
Parameters
$group : SetaPDF_Core_Document_OptionalContent_Group
 
$on : bool
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

addGroup()

public SetaPDF_Core_Document_Catalog_OptionalContent::addGroup (): 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 SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

addUsageApplication()

public SetaPDF_Core_Document_Catalog_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(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 SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

See

appendGroup()

public SetaPDF_Core_Document_Catalog_OptionalContent::appendGroup (
string|SetaPDF_Core_Document_OptionalContent_Group $group [, SetaPDF_Core_Document_OptionalContent_Group $parent = null [, integer|null $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 : integer|null
 
$nextToOrLabel : string|SetaPDF_Core_Document_OptionalContent_Group
 
$label : string
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

cleanUp()

public SetaPDF_Core_Document_Catalog_OptionalContent::cleanUp (
void
): void

Release resources / cycled references.

getAsArray()

public SetaPDF_Core_Document_Catalog_OptionalContent::getAsArray (
[ boolean $create = false ]
): null|SetaPDF_Core_Type_Array

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

Parameters
$create : boolean
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

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

getBaseState()

public SetaPDF_Core_Document_Catalog_OptionalContent::getBaseState (
void
): string

Get the base state from the default viewing dictionary.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

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

getDefaultViewingDictionary()

public SetaPDF_Core_Document_Catalog_OptionalContent::getDefaultViewingDictionary (
[ boolean $create = false ]
): null|SetaPDF_Core_Type_Dictionary

Get the default viewing dictionary.

Parameters
$create : boolean
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

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

getDocument()

public SetaPDF_Core_Document_Catalog_OptionalContent::getDocument (
void
): SetaPDF_Core_Document

Get the document instance.

getGroup()

public SetaPDF_Core_Document_Catalog_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 SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getGroups()

public SetaPDF_Core_Document_Catalog_OptionalContent::getGroups (
void
): SetaPDF_Core_Document_OptionalContent_Group[]

Get all available content groups.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getIterator()

public SetaPDF_Core_Document_Catalog_OptionalContent::getIterator (
void
): SetaPDF_Core_Document_OptionalContent_Iterator|EmptyIterator

Implementation of IteratorAggregate.

A separate iterator is needed to receive SetaPDF_Core_Document_OptionalContent_Group objects while iterating.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

See

getOffArray()

public SetaPDF_Core_Document_Catalog_OptionalContent::getOffArray (
[ boolean $create = false ]
): null|SetaPDF_Core_Type_Array

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

Parameters
$create : boolean
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

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

getOnArray()

public SetaPDF_Core_Document_Catalog_OptionalContent::getOnArray (
[ boolean $create = false ]
): null|SetaPDF_Core_Type_Array

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

Parameters
$create : boolean
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

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

getOptionalContentPropertiesDictionary()

public SetaPDF_Core_Document_Catalog_OptionalContent::getOptionalContentPropertiesDictionary (
[ boolean $create = false ]
): null|SetaPDF_Core_Type_Dictionary

Get and creates the optional content properties dictionary.

Parameters
$create : boolean
 
Exceptions

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_SecHandler_Exception

getOrderArray()

public SetaPDF_Core_Document_Catalog_OptionalContent::getOrderArray (
[ boolean $create = false ]
): null|SetaPDF_Core_Type_Array

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

Parameters
$create : boolean
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

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

prependGroup()

public SetaPDF_Core_Document_Catalog_OptionalContent::prependGroup (
string|SetaPDF_Core_Document_OptionalContent_Group $group [, SetaPDF_Core_Document_OptionalContent_Group $parent = null [, integer|null $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 : integer|null
 
$nextToOrLabel : string|SetaPDF_Core_Document_OptionalContent_Group
 
$label : string
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

setBaseState()

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

Set the base state in the default viewing dictionary.

Parameters
$baseState : string
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

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

setOff()

public SetaPDF_Core_Document_Catalog_OptionalContent::setOff (): void

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

Parameters
$group : SetaPDF_Core_Document_OptionalContent_Group
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

setOn()

public SetaPDF_Core_Document_Catalog_OptionalContent::setOn (): void

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

Parameters
$group : SetaPDF_Core_Document_OptionalContent_Group
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception


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