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

AdditionalActions Class representing the document catalog’s additional-actions dictionary

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

Class hierarchy

Summary

Methods

Properties

Properties

$_catalog

protected \SetaPDF_Core_Document_Catalog AdditionalActions::$_catalog

The catalog instance


Methods

__construct()

public AdditionalActions::__construct ()

The constructor.

Parameters
$catalog : \SetaPDF_Core_Document_Catalog
 

_getAction()

protected AdditionalActions::_getAction (
string $name,
bool $instance = true
): ?\SetaPDF_Core_Document_Action_JavaScript

Get the action.

Parameters
$name : string
 
$instance : bool
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

_setAction()

protected AdditionalActions::_setAction (): void

Set the action.

Parameters
$name : string
 
$javaScriptAction : string|\SetaPDF_Core_Document_Action_JavaScript|\SetaPDF_Core_Type_Dictionary|\SetaPDF_Core_Type_IndirectObjectInterface
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

cleanUp()

public AdditionalActions::cleanUp (
void
): void

Release memory/cycled references.

getDictionary()

public AdditionalActions::getDictionary (
bool $create = false
): null|\SetaPDF_Core_Type_AbstractType|\SetaPDF_Core_Type_Dictionary

Get the additional actions dictionary.

Parameters
$create : bool

Pass true to automatically create the dictionary

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

getDidPrint()

public AdditionalActions::getDidPrint (
void
): ?\SetaPDF_Core_Document_Action_JavaScript

Get the JavaScript action that shall be performed after printing the document.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

getDidSave()

public AdditionalActions::getDidSave (
void
): ?\SetaPDF_Core_Document_Action_JavaScript

Get the JavaScript action that shall be performed after saving the document.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

getDocument()

public AdditionalActions::getDocument (
void
): \SetaPDF_Core_Document

Get the document instance.

getWillClose()

public AdditionalActions::getWillClose (
void
): ?\SetaPDF_Core_Document_Action_JavaScript

Get the JavaScript action that shall be performed before closing the document.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

getWillPrint()

public AdditionalActions::getWillPrint (
void
): ?\SetaPDF_Core_Document_Action_JavaScript

Get the JavaScript action that shall be performed before printing the document.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

getWillSave()

public AdditionalActions::getWillSave (
void
): ?\SetaPDF_Core_Document_Action_JavaScript

Get the JavaScript action that shall be performed before saving the document.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

setDidPrint()

public AdditionalActions::setDidPrint (): \SetaPDF_Core_Document_Catalog_AdditionalActions

Set the JavaScript action that shall be performed after printing the document.

Parameters
$javaScriptAction : string|\SetaPDF_Core_Document_Action_JavaScript|\SetaPDF_Core_Type_Dictionary|\SetaPDF_Core_Type_IndirectObjectInterface
 
Return Values

Returns the AdditionalActions object for method chaining.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

setDidSave()

public AdditionalActions::setDidSave (): \SetaPDF_Core_Document_Catalog_AdditionalActions

Set the JavaScript action that shall be performed after saving the document.

Parameters
$javaScriptAction : string|\SetaPDF_Core_Document_Action_JavaScript|\SetaPDF_Core_Type_Dictionary|\SetaPDF_Core_Type_IndirectObjectInterface
 
Return Values

Returns the AdditionalActions object for method chaining.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

setWillClose()

public AdditionalActions::setWillClose (): \SetaPDF_Core_Document_Catalog_AdditionalActions

Set the JavaScript action that shall be performed before closing the document.

Parameters
$javaScriptAction : string|\SetaPDF_Core_Document_Action_JavaScript|\SetaPDF_Core_Type_Dictionary|\SetaPDF_Core_Type_IndirectObjectInterface
 
Return Values

Returns the AdditionalActions object for method chaining.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

setWillPrint()

public AdditionalActions::setWillPrint (): \SetaPDF_Core_Document_Catalog_AdditionalActions

Set the JavaScript action that shall be performed before printing the document.

Parameters
$javaScriptAction : string|\SetaPDF_Core_Document_Action_JavaScript|\SetaPDF_Core_Type_Dictionary|\SetaPDF_Core_Type_IndirectObjectInterface
 
Return Values

Returns the AdditionalActions object for method chaining.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

setWillSave()

public AdditionalActions::setWillSave (): \SetaPDF_Core_Document_Catalog_AdditionalActions

Set the JavaScript action that shall be performed before saving the document.

Parameters
$javaScriptAction : string|\SetaPDF_Core_Document_Action_JavaScript|\SetaPDF_Core_Type_Dictionary|\SetaPDF_Core_Type_IndirectObjectInterface
 
Return Values

Returns the AdditionalActions object for method chaining.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception


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