Class SubmitFormAction 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

SubmitFormAction Class representing a submit-form action

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

Send data to a uniform resource locator. See PDF 32000-1:2008 - 12.7.5.2 Submit-Form Action

Class hierarchy

Action
- FormAction
  - SubmitFormAction

Summary

Constants

FLAG_CANONICAL_FORMAT

public const SubmitFormAction::FLAG_CANONICAL_FORMAT = 1024

Action flag

FLAG_EMBED_FORM

public const SubmitFormAction::FLAG_EMBED_FORM = 16384

Action flag

FLAG_EXCLUDE

public const SubmitFormAction::FLAG_EXCLUDE = 1

Action flag

FLAG_EXCL_FKEY

public const SubmitFormAction::FLAG_EXCL_FKEY = 4096

Action flag

FLAG_EXCL_NON_USER_ANNOTS

public const SubmitFormAction::FLAG_EXCL_NON_USER_ANNOTS = 2048

Action flag

FLAG_EXPORT_FORMAT

public const SubmitFormAction::FLAG_EXPORT_FORMAT = 4

Action flag

FLAG_GET_METHOD

public const SubmitFormAction::FLAG_GET_METHOD = 8

Action flag

FLAG_INCLUDE_ANNOTATIONS

public const SubmitFormAction::FLAG_INCLUDE_ANNOTATIONS = 128

Action flag

FLAG_INCLUDE_APPEND_SAVES

public const SubmitFormAction::FLAG_INCLUDE_APPEND_SAVES = 64

Action flag

FLAG_INCLUDE_NO_VALUE_FIELDS

public const SubmitFormAction::FLAG_INCLUDE_NO_VALUE_FIELDS = 2

Action flag

FLAG_SUBMIT_COORDINATES

public const SubmitFormAction::FLAG_SUBMIT_COORDINATES = 16

Action flag

FLAG_SUBMIT_PDF

public const SubmitFormAction::FLAG_SUBMIT_PDF = 256

Action flag

FLAG_XFDF

public const SubmitFormAction::FLAG_XFDF = 32

Action flag

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

createActionDictionary()

public static SubmitFormAction::createActionDictionary (

string|\SetaPDF_Core_FileSpecification|\SetaPDF_Core_Type_IndirectObjectInterface|\SetaPDF_Core_Type_Dictionary|\SetaPDF_Core_Type_StringValue $fileSpecification

): \SetaPDF_Core_Type_Dictionary

Create a SubmitForm Action dictionary.

Parameters

$fileSpecification : string|\SetaPDF_Core_FileSpecification|\SetaPDF_Core_Type_IndirectObjectInterface|\SetaPDF_Core_Type_Dictionary|\SetaPDF_Core_Type_StringValue

Exceptions

Throws \InvalidArgumentException

Throws \setasign\SetaPDF2\Core\Type\Exception

Methods

__construct()

public SubmitFormAction::__construct (

string|\SetaPDF_Core_Type_Dictionary|\SetaPDF_Core_Type_IndirectObjectInterface $objectOrDictionary

)

The constructor.

Parameters

$objectOrDictionary : string|\SetaPDF_Core_Type_Dictionary|\SetaPDF_Core_Type_IndirectObjectInterface

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.

getCharSet()

public SubmitFormAction::getCharSet (

void

): ?mixed

Get the char set in which the data should be transfered (PDF 2.0)

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

getFileSpecification()

public SubmitFormAction::getFileSpecification (

void

): \SetaPDF_Core_FileSpecification

Get the file specification object.

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

setCharSet()

public SubmitFormAction::setCharSet (

string|\SetaPDF_Core_Type_StringValue|false $charSet

): void

Set the char set in which the data should be transfered (PDF 2.0)

Possible values include: utf-8, utf-16, Shift-JIS, BigFive, GBK, or UHC.

Parameters

$charSet : string|\SetaPDF_Core_Type_StringValue|false

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()

setFileSpecification()

public SubmitFormAction::setFileSpecification (

string|\SetaPDF_Core_FileSpecification $fileSpecification

): void

Seta a file specification object.

Parameters

$fileSpecification : string|\SetaPDF_Core_FileSpecification

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

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