Abstract Class SetaPDF_Core_Document_Action_Form in SetaPDF v2 API Reference

Index

\SetaPDF
1. Core
2. Core
  1. Document
  2. Document
    1. Action
    2. Action
      1. Form
      2. GoTo
      3. GoToR
      4. ImportData
      5. JavaScript
      6. Launch
      7. Named
      8. ResetForm
      9. SubmitForm
      10. Uri

SetaPDF_Core_Document_Action_Form Abstract class for form actions

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

Class hierarchy

SetaPDF_Core_Document_Action
- SetaPDF_Core_Document_Action_Form
  - SetaPDF_Core_Document_Action_ResetForm
  - SetaPDF_Core_Document_Action_SubmitForm

Summary

Properties

$_actionDictionary

protected SetaPDF_Core_Type_Dictionary SetaPDF_Core_Document_Action::$_actionDictionary

The action dictionary

$_indirectReference

protected SetaPDF_Core_Type_IndirectObjectInterface SetaPDF_Core_Document_Action::$_indirectReference

Static Methods

byObjectOrDictionary()

public static SetaPDF_Core_Document_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 SetaPDF_Core_Type_Exception

Throws InvalidArgumentException

Methods

__construct()

public SetaPDF_Core_Document_Action::__construct (

SetaPDF_Core_Type_AbstractType $objectOrDictionary

)

The constructor.

Parameters

$objectOrDictionary : SetaPDF_Core_Type_AbstractType

Exceptions

Throws InvalidArgumentException

Throws SetaPDF_Core_Type_Exception

addNext()

public SetaPDF_Core_Document_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 SetaPDF_Core_Type_Exception

getActionDictionary()

public SetaPDF_Core_Document_Action::getActionDictionary (

void

): SetaPDF_Core_Type_Dictionary

Get the action dictionary.

getFields()

public SetaPDF_Core_Document_Action_Form::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 SetaPDF_Core_Type_Exception

getFlags()

public SetaPDF_Core_Document_Action_Form::getFlags (

void

): int

Returns the current flags.

Exceptions

Throws SetaPDF_Core_Type_Exception

getIndirectObject()

public SetaPDF_Core_Document_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 SetaPDF_Core_Document_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 SetaPDF_Core_Document_Action::getPdfValue (

void

): SetaPDF_Core_Type_Dictionary

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 (

int $flag

): bool

Checks if a specific flag is set.

Parameters

$flag : int

Exceptions

Throws SetaPDF_Core_Type_Exception

setFields()

public SetaPDF_Core_Document_Action_Form::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

SetaPDF_Core_Document_Action_Form::setFlags()

setFlags()

public SetaPDF_Core_Document_Action_Form::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 SetaPDF_Core_Type_Exception

setIndirectObject()

public SetaPDF_Core_Document_Action::setIndirectObject (

SetaPDF_Core_Type_IndirectObjectInterface $indirectReference

): void

Set the indirect object of this annotation.

Parameters

$indirectReference : SetaPDF_Core_Type_IndirectObjectInterface

setNext()

public SetaPDF_Core_Document_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 SetaPDF_Core_Document_Action_Form::unsetFlags (

int $flags

): void

Removes a flag or flags.

Parameters

$flags : int

Exceptions

Throws SetaPDF_Core_Type_Exception