SetaPDF_Core_Document_Action_SubmitForm Class representing a submit-form action

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

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

Class hierarchy

Summary

Constants

FLAG_CANONICAL_FORMAT

const SetaPDF_Core_Document_Action_SubmitForm::FLAG_CANONICAL_FORMAT = 1024

Action flag

FLAG_EMBED_FORM

const SetaPDF_Core_Document_Action_SubmitForm::FLAG_EMBED_FORM = 16384

Action flag

FLAG_EXCLUDE

const SetaPDF_Core_Document_Action_SubmitForm::FLAG_EXCLUDE = 1

Action flag

FLAG_EXCL_FKEY

const SetaPDF_Core_Document_Action_SubmitForm::FLAG_EXCL_FKEY = 4096

Action flag

FLAG_EXCL_NON_USER_ANNOTS

const SetaPDF_Core_Document_Action_SubmitForm::FLAG_EXCL_NON_USER_ANNOTS = 2048

Action flag

FLAG_EXPORT_FORMAT

const SetaPDF_Core_Document_Action_SubmitForm::FLAG_EXPORT_FORMAT = 4

Action flag

FLAG_GET_METHOD

const SetaPDF_Core_Document_Action_SubmitForm::FLAG_GET_METHOD = 8

Action flag

FLAG_INCLUDE_ANNOTATIONS

const SetaPDF_Core_Document_Action_SubmitForm::FLAG_INCLUDE_ANNOTATIONS = 128

Action flag

FLAG_INCLUDE_APPEND_SAVES

const SetaPDF_Core_Document_Action_SubmitForm::FLAG_INCLUDE_APPEND_SAVES = 64

Action flag

FLAG_INCLUDE_NO_VALUE_FIELDS

const SetaPDF_Core_Document_Action_SubmitForm::FLAG_INCLUDE_NO_VALUE_FIELDS = 2

Action flag

FLAG_SUBMIT_COORDINATES

const SetaPDF_Core_Document_Action_SubmitForm::FLAG_SUBMIT_COORDINATES = 16

Action flag

FLAG_SUBMIT_PDF

const SetaPDF_Core_Document_Action_SubmitForm::FLAG_SUBMIT_PDF = 256

Action flag

FLAG_XFDF

const SetaPDF_Core_Document_Action_SubmitForm::FLAG_XFDF = 32

Action flag


Properties

$_actionDictionary

protected SetaPDF_Core_Type_Dictionary SetaPDF_Core_Document_Action_SubmitForm::$_actionDictionary

The action dictionary

$_indirectReference

protected SetaPDF_Core_Type_IndirectObjectInterface SetaPDF_Core_Document_Action_SubmitForm::$_indirectReference


Static Methods

byObjectOrDictionary()

Creates an action object by an action dictionary.

Parameters
$objectOrDictionary : SetaPDF_Core_Type_AbstractType
 
Exceptions

Throws InvalidArgumentException

createActionDictionary()

Create a Named Action dictionary.

Parameters
$fileSpecification : string|
 
Exceptions

Throws InvalidArgumentException


Methods

addNext()

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

Parameters
$next : SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Document_Action
 

getActionDictionary()

getCharSet()

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

getFields()

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

Get the fields to include or exclude in the submission.

Parameters
$encoding : string

The input encoding

Return Values

An array of field names in the specific encoding

getFileSpecification()

getFlags()

Returns the current flags.

getIndirectObject()

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

Parameters
$document : SetaPDF_Core_Document

The document instance

getNext()

Gets the PDF value of the next entry.

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_SubmitForm::isFlagSet (
integer $flag
): boolean

Checks if a specific flag is set.

Parameters
$flag : integer
 

setCharSet()

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
 

setFields()

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

Set which fields to include in the submission or which to exclude, 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

setFileSpecification()

Seta a file specification object.

Parameters
$fileSpecification : string|SetaPDF_Core_FileSpecification
 

setFlags()

public SetaPDF_Core_Document_Action_SubmitForm::setFlags (
integer $flags [, boolean|null $add = true ]
): void

Sets a flag or flags.

Parameters
$flags : integer
 
$add : boolean|null

Add = true, remove = false, set = null

setIndirectObject()

Set the indirect object of this annotation.

Parameters
$indirectReference : SetaPDF_Core_Type_IndirectObjectInterface
 

setNext()

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

Parameters
$next : SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Document_Action
 

unsetFlags()

public SetaPDF_Core_Document_Action_SubmitForm::unsetFlags (
integer $flags
): void

Removes a flag or flags.

Parameters
$flags : integer