SetaPDF_Core_Document_Action_Form Abstract class for form actions

File: /SetaPDF v2/Core/Document/Action/Form.php

Class hierarchy

Summary

Properties

$_actionDictionary


Static Methods

byObjectOrDictionary()

Creates an action object by an action dictionary.

Parameters
$objectOrDictionary : SetaPDF_Core_Type_AbstractType
 
Exceptions

Throws SetaPDF_Core_Type_Exception

Throws InvalidArgumentException


Methods

__construct()

The constructor.

Parameters
$objectOrDictionary : SetaPDF_Core_Type_AbstractType
 
Exceptions

Throws InvalidArgumentException

Throws SetaPDF_Core_Type_Exception

addNext()

public SetaPDF_Core_Document_Action::addNext (
$next
): void

Add an additional action to the next value of this action.

Parameters
$next
 
Exceptions

Throws SetaPDF_Core_Type_Exception

getActionDictionary()

getFields()

public SetaPDF_Core_Document_Action_Form::getFields (
[ $encoding = 'UTF-8' ]
): array|null

Get the fields to include or exclude in the submission.

Parameters
$encoding

The output encoding

Return Values

An array of field names in the specific encoding

Exceptions

Throws SetaPDF_Core_Type_Exception

getFlags()

Returns the current flags.

Exceptions

Throws SetaPDF_Core_Type_Exception

getIndirectObject()

Get the indirect object of this annotation or creates it in the specific document context.

Parameters
$document : SetaPDF_Core_Document|null

The document instance

getPdfValue()

Get the PDF value of this action.

getType()

public SetaPDF_Core_Document_Action::getType (
void
): string

Get the action type specified in the S key.

isFlagSet()

public SetaPDF_Core_Document_Action_Form::isFlagSet (
$flag
): boolean

Checks if a specific flag is set.

Parameters
$flag
 
Exceptions

Throws SetaPDF_Core_Type_Exception

setFields()

public SetaPDF_Core_Document_Action_Form::setFields (
[ array|null $fields = null [, $encoding = 'UTF-8' ]]
): void

Set which fields to reset or which to exclude from resetting, depending on the setting of the Include/Exclude flag.

Parameters
$fields : array|null

An array of fully qualified names or an indirect object to a field dictionary

$encoding

The input encoding

See

setFlags()

public SetaPDF_Core_Document_Action_Form::setFlags (
$flags [, $add = true ]
): void

Sets a flag or flags.

Parameters
$flags
 
$add

Add = true, remove = false, set = null

Exceptions

Throws SetaPDF_Core_Type_Exception

setIndirectObject()

Set the indirect object of this annotation.

Parameters
$indirectReference : SetaPDF_Core_Type_IndirectObjectInterface
 

setNext()

public SetaPDF_Core_Document_Action::setNext (
$next
): void

Set the next action which should be executed after this one.

Parameters
$next
 

unsetFlags()

Removes a flag or flags.

Parameters
$flags
 
Exceptions

Throws SetaPDF_Core_Type_Exception