Abstract Class FormAction in namespace setasign\SetaPDF2\Core\Document\Action in SetaPDF v2 API Reference

Index

\setasign\SetaPDF2
1. Core
  1. Document
  2. Document
    1. Action

setasign\SetaPDF2\Core\Document\Action

FormAction Abstract class for form actions

File: /SetaPDF v2/Core/Document/Action/FormAction.php
Old class name (alias): \SetaPDF_Core_Document_Action_Form

Class hierarchy

Action
- FormAction
  - ResetAction
  - SubmitFormAction

Summary

Properties

$_actionDictionary

protected \SetaPDF_Core_Type_Dictionary Action::$_actionDictionary

The action dictionary

$_indirectReference

protected \SetaPDF_Core_Type_IndirectObjectInterface Action::$_indirectReference

Static Methods

byObjectOrDictionary()

public static Action::byObjectOrDictionary (

\SetaPDF_Core_Type_IndirectObject|\SetaPDF_Core_Type_IndirectReference|\SetaPDF_Core_Type_Dictionary $objectOrDictionary

): \SetaPDF_Core_Document_Action

Creates an action object by an action dictionary.

Parameters

$objectOrDictionary : \SetaPDF_Core_Type_IndirectObject|\SetaPDF_Core_Type_IndirectReference|\SetaPDF_Core_Type_Dictionary

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \InvalidArgumentException

Methods

__construct()

public Action::__construct (

\SetaPDF_Core_Type_AbstractType $objectOrDictionary

)

The constructor.

Parameters

$objectOrDictionary : \SetaPDF_Core_Type_AbstractType

Exceptions

Throws \InvalidArgumentException

Throws \setasign\SetaPDF2\Core\Type\Exception

addNext()

public Action::addNext (

\SetaPDF_Core_Type_Dictionary|\SetaPDF_Core_Document_Action $next

): void

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

Parameters

$next : \SetaPDF_Core_Type_Dictionary|\SetaPDF_Core_Document_Action

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getActionDictionary()

public Action::getActionDictionary (

void

): \SetaPDF_Core_Type_Dictionary

Get the action dictionary.

getFields()

public FormAction::getFields (

string $encoding = 'UTF-8'

): ?array

Get the fields to include or exclude in the submission.

Parameters

$encoding : string: The output encoding

Return Values

An array of field names in the specific encoding

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getFlags()

public FormAction::getFlags (

void

): int

Returns the current flags.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getIndirectObject()

public Action::getIndirectObject (

?\SetaPDF_Core_Document $document = null

): \SetaPDF_Core_Type_IndirectObjectInterface

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

Parameters

$document : ?\SetaPDF_Core_Document: The document instance

getNext()

public Action::getNext (

void

): false|\SetaPDF_Core_Type_Dictionary|\SetaPDF_Core_Type_Array|\SetaPDF_Core_Type_IndirectReference

Gets the PDF value of the next entry.

getPdfValue()

public Action::getPdfValue (

void

): \SetaPDF_Core_Type_Dictionary

Get the PDF value of this action.

getType()

public Action::getType (

void

): string

Get the action type specified in the S key.

isFlagSet()

public FormAction::isFlagSet (

int $flag

): bool

Checks if a specific flag is set.

Parameters

$flag : int

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

setFields()

public FormAction::setFields (

?array $fields = null,
string $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: An array of fully qualified names or an indirect object to a field dictionary
$encoding : string: The input encoding

See

FormAction::setFlags()

setFlags()

public FormAction::setFlags (

int $flags,
?bool $add = true

): void

Sets a flag or flags.

Parameters

$flags : int
$add : ?bool: Add = true, remove = false, set = null

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

setIndirectObject()

public Action::setIndirectObject (

\SetaPDF_Core_Type_IndirectObjectInterface $indirectReference

): void

Set the indirect object of this annotation.

Parameters

$indirectReference : \SetaPDF_Core_Type_IndirectObjectInterface

setNext()

public Action::setNext (

\SetaPDF_Core_Type_Dictionary|\SetaPDF_Core_Document_Action|\SetaPDF_Core_Type_IndirectObjectInterface $next

): void

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

Parameters

$next : \SetaPDF_Core_Type_Dictionary|\SetaPDF_Core_Document_Action|\SetaPDF_Core_Type_IndirectObjectInterface

unsetFlags()

public FormAction::unsetFlags (

int $flags

): void

Removes a flag or flags.

Parameters

$flags : int

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception