SetaPDF_Core_Document_Action_SubmitForm Class representing a submit-form action

File: /SetaPDF/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

FLAG_EMBED_FORM

FLAG_EXCLUDE

FLAG_EXCL_FKEY

FLAG_EXCL_NON_USER_ANNOTS

FLAG_EXPORT_FORMAT

FLAG_GET_METHOD

FLAG_INCLUDE_ANNOTATIONS

FLAG_INCLUDE_APPEND_SAVES

FLAG_INCLUDE_NO_VALUE_FIELDS

FLAG_SUBMIT_COORDINATES

FLAG_SUBMIT_PDF

FLAG_XFDF


Properties


Static Methods

byObjectOrDictionary()

static public SetaPDF_Core_Document_Action SetaPDF_Core_Document_Action::byObjectOrDictionary ( SetaPDF_Core_Type_AbstractType $objectOrDictionary )

Creates an action object by an action dictionary.

Parameters
$objectOrDictionary : SetaPDF_Core_Type_AbstractType
 
Exceptions

Throws InvalidArgumentException

createActionDictionary()

static public SetaPDF_Core_Type_Dictionary SetaPDF_Core_Document_Action_SubmitForm::createActionDictionary ( string| $fileSpecification )

Create a Named Action dictionary.

Parameters
$fileSpecification : string|
 
Exceptions

Throws InvalidArgumentException


Methods

__construct()

public SetaPDF_Core_Document_Action_SubmitForm::__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

addNext()

public void SetaPDF_Core_Document_Action::addNext ( SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Document_Action $next )

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

Parameters
$next : SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Document_Action
 

getActionDictionary()

public SetaPDF_Core_Type_Dictionary SetaPDF_Core_Document_Action::getActionDictionary ( void )

Get the action dictionary.

getCharSet()

public mixed|null SetaPDF_Core_Document_Action_SubmitForm::getCharSet ( void )

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

getFields()

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

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

public SetaPDF_Core_FileSpecification SetaPDF_Core_Document_Action_SubmitForm::getFileSpecification ( void )

Get the file specification object.

getFlags()

public integer SetaPDF_Core_Document_Action_SubmitForm::getFlags ( void )

Returns the current flags.

getIndirectObject()

public SetaPDF_Core_Type_IndirectObjectInterface SetaPDF_Core_Document_Action::getIndirectObject ( [ SetaPDF_Core_Document $document = null ] )

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 false|SetaPDF_Core_Type_Dictionary SetaPDF_Core_Document_Action::getNext ( void )

Gets the PDF value of the next entry.

getPdfValue()

public SetaPDF_Core_Type_Dictionary SetaPDF_Core_Document_Action::getPdfValue ( void )

Get the PDF value of this action.

getType()

public string SetaPDF_Core_Document_Action::getType ( void )

Get the action type specified in the S key.

isFlagSet()

public boolean SetaPDF_Core_Document_Action_SubmitForm::isFlagSet ( integer $flag )

Checks if a specific flag is set.

Parameters
$flag : integer
 

setCharSet()

public void SetaPDF_Core_Document_Action_SubmitForm::setCharSet ( $charSet $charSet )

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 : $charSet
 

setFields()

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

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

public void SetaPDF_Core_Document_Action_SubmitForm::setFileSpecification ( string|SetaPDF_Core_FileSpecification $fileSpecification )

Seta a file specification object.

Parameters
$fileSpecification : string|SetaPDF_Core_FileSpecification
 

setFlags()

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

Sets a flag or flags.

Parameters
$flags : integer
 
$add : boolean|null

Add = true, remove = false, set = null

setIndirectObject()

public void SetaPDF_Core_Document_Action::setIndirectObject ( SetaPDF_Core_Type_IndirectObjectInterface $indirectReference )

Set the indirect object of this annotation.

Parameters
$indirectReference : SetaPDF_Core_Type_IndirectObjectInterface
 

setNext()

public void SetaPDF_Core_Document_Action::setNext ( SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Document_Action $next )

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

Parameters
$next : SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Document_Action
 

unsetFlags()

public void SetaPDF_Core_Document_Action_SubmitForm::unsetFlags ( integer $flags )

Removes a flag or flags.

Parameters
$flags : integer