Index

  1. \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_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

Static Methods

Methods

Properties

Constants

Constants

FLAG_CANONICAL_FORMAT

public const SetaPDF_Core_Document_Action_SubmitForm::FLAG_CANONICAL_FORMAT = 1024

Action flag

FLAG_EMBED_FORM

public const SetaPDF_Core_Document_Action_SubmitForm::FLAG_EMBED_FORM = 16384

Action flag

FLAG_EXCLUDE

public const SetaPDF_Core_Document_Action_SubmitForm::FLAG_EXCLUDE = 1

Action flag

FLAG_EXCL_FKEY

public const SetaPDF_Core_Document_Action_SubmitForm::FLAG_EXCL_FKEY = 4096

Action flag

FLAG_EXCL_NON_USER_ANNOTS

public const SetaPDF_Core_Document_Action_SubmitForm::FLAG_EXCL_NON_USER_ANNOTS = 2048

Action flag

FLAG_EXPORT_FORMAT

public const SetaPDF_Core_Document_Action_SubmitForm::FLAG_EXPORT_FORMAT = 4

Action flag

FLAG_GET_METHOD

public const SetaPDF_Core_Document_Action_SubmitForm::FLAG_GET_METHOD = 8

Action flag

FLAG_INCLUDE_ANNOTATIONS

public const SetaPDF_Core_Document_Action_SubmitForm::FLAG_INCLUDE_ANNOTATIONS = 128

Action flag

FLAG_INCLUDE_APPEND_SAVES

public const SetaPDF_Core_Document_Action_SubmitForm::FLAG_INCLUDE_APPEND_SAVES = 64

Action flag

FLAG_INCLUDE_NO_VALUE_FIELDS

public const SetaPDF_Core_Document_Action_SubmitForm::FLAG_INCLUDE_NO_VALUE_FIELDS = 2

Action flag

FLAG_SUBMIT_COORDINATES

public const SetaPDF_Core_Document_Action_SubmitForm::FLAG_SUBMIT_COORDINATES = 16

Action flag

FLAG_SUBMIT_PDF

public const SetaPDF_Core_Document_Action_SubmitForm::FLAG_SUBMIT_PDF = 256

Action flag

FLAG_XFDF

public const SetaPDF_Core_Document_Action_SubmitForm::FLAG_XFDF = 32

Action flag


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_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

createActionDictionary()

public static SetaPDF_Core_Document_Action_SubmitForm::createActionDictionary (): 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 SetaPDF_Core_Type_Exception


Methods

__construct()

public SetaPDF_Core_Document_Action_SubmitForm::__construct ()

The constructor.

Parameters
$objectOrDictionary : string|SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Type_IndirectObjectInterface
 
Exceptions

Throws InvalidArgumentException

Throws SetaPDF_Core_Type_Exception

addNext()

public SetaPDF_Core_Document_Action::addNext (): 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.

getCharSet()

public SetaPDF_Core_Document_Action_SubmitForm::getCharSet (
void
): mixed|null

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

getFields()

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

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

getFileSpecification()

public SetaPDF_Core_Document_Action_SubmitForm::getFileSpecification (
void
): SetaPDF_Core_FileSpecification

Get the file specification object.

Exceptions

Throws SetaPDF_Core_Type_Exception

getFlags()

public SetaPDF_Core_Document_Action_Form::getFlags (
void
): integer

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

Checks if a specific flag is set.

Parameters
$flag : integer
 
Exceptions

Throws SetaPDF_Core_Type_Exception

setCharSet()

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

setFileSpecification()

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

Seta a file specification object.

Parameters
$fileSpecification : string|SetaPDF_Core_FileSpecification
 
Exceptions

Throws SetaPDF_Core_Type_Exception

setFlags()

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

Exceptions

Throws SetaPDF_Core_Type_Exception

setIndirectObject()

public SetaPDF_Core_Document_Action::setIndirectObject (): void

Set the indirect object of this annotation.

Parameters
$indirectReference : SetaPDF_Core_Type_IndirectObjectInterface
 

setNext()

public SetaPDF_Core_Document_Action::setNext (): 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 (
integer $flags
): void

Removes a flag or flags.

Parameters
$flags : integer
 
Exceptions

Throws SetaPDF_Core_Type_Exception


© 2024 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)