Index

  1. \SetaPDF
    1. FormFiller
    2. FormFiller
      1. Xfa
      2. Xfa
        1. Bridge
        2. Som

SetaPDF_FormFiller_Xfa Class offering access to XFA data of a PDF form.

File: /SetaPDF v2/FormFiller/Xfa.php

Class hierarchy

Summary

Methods

Properties

Properties

$_bridge

protected SetaPDF_FormFiller_Xfa_Bridge SetaPDF_FormFiller_Xfa::$_bridge

The bridge instance.

$_data

protected DOMNode SetaPDF_FormFiller_Xfa::$_data

The data node.

$_dataNodeUpdated

protected bool SetaPDF_FormFiller_Xfa::$_dataNodeUpdated = false

Flag indicating if the data has to be set back to the data stream on save.

$_domDocument

protected DOMDocument SetaPDF_FormFiller_Xfa::$_domDocument

The document instance of the full XDP packet.

$_form

protected DOMNode SetaPDF_FormFiller_Xfa::$_form

The form node.

$_formFiller

protected SetaPDF_FormFiller SetaPDF_FormFiller_Xfa::$_formFiller

The form filler instance

$_setValueIsActive

protected bool SetaPDF_FormFiller_Xfa::$_setValueIsActive = false

Flag identicating that a setValue() process is working.

$_template

protected DOMNode SetaPDF_FormFiller_Xfa::$_template

The template node.

$_templateNodeUpdated

protected bool SetaPDF_FormFiller_Xfa::$_templateNodeUpdated = false

Flag indicating that the template node was changed.


Methods

__construct()

public SetaPDF_FormFiller_Xfa::__construct (
SetaPDF_FormFiller $formFiller
)

The constructor.

Parameters
$formFiller : SetaPDF_FormFiller

The form filler instance

_evaluateValue()

private SetaPDF_FormFiller_Xfa::_evaluateValue (
mixed $value, DOMElement $fieldNode
): DOMNode|string

Evaluates a native value to a data value.

Parameters
$value : mixed
 
$fieldNode : DOMElement
 

_findPacketStream()

private SetaPDF_FormFiller_Xfa::_findPacketStream (
SetaPDF_Core_Type_Array $array, string $name [, boolean $create = false ]
): bool|SetaPDF_Core_Type_Stream

Finds a packets stream by its name.

Parameters
$array : SetaPDF_Core_Type_Array
 
$name : string
 
$create : boolean
 

_setValueInForm()

protected SetaPDF_FormFiller_Xfa::_setValueInForm (
string $fieldName, mixed $value
): bool

Creates the data node and sets the value in the form package.

Parameters
$fieldName : string
 
$value : mixed
 
Exceptions

Throws SetaPDF_FormFiller_Exception

cleanUp()

public SetaPDF_FormFiller_Xfa::cleanUp (
void
): void

Releases memory and resources.

getBridge()

public SetaPDF_FormFiller_Xfa::getBridge (
void
): SetaPDF_FormFiller_Xfa_Bridge

Get the XFA bridge helper object.

Exceptions

Throws SetaPDF_FormFiller_Exception

getData()

public SetaPDF_FormFiller_Xfa::getData (
[ bool $create = false ]
): bool|DOMElement

Get the data node.

Parameters
$create : bool
 

getDomDocument()

public SetaPDF_FormFiller_Xfa::getDomDocument (
void
): DOMDocument

Get the DOMDocument instance of the XFA structure.

Exceptions

Throws SetaPDF_FormFiller_Exception

getFormFiller()

public SetaPDF_FormFiller_Xfa::getFormFiller (
void
): SetaPDF_FormFiller

Get the form filler instance.

getFormNode()

public SetaPDF_FormFiller_Xfa::getFormNode (
void
): DOMElement

Get the form node.

Exceptions

Throws SetaPDF_FormFiller_Exception

getFormNodeChecksum()

public SetaPDF_FormFiller_Xfa::getFormNodeChecksum (
void
): string

Calculate and get the checksum for the form node.

Exceptions

Throws SetaPDF_FormFiller_Exception

getObject()

public SetaPDF_FormFiller_Xfa::getObject (
void
): false|SetaPDF_Core_Type_AbstractType

Get the XFA pdf object.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

getTemplate()

public SetaPDF_FormFiller_Xfa::getTemplate (
void
): bool|DOMElement

Gets the template node from the XFA structure.

Exceptions

Throws SetaPDF_FormFiller_Exception

getXml()

public SetaPDF_FormFiller_Xfa::getXml (
void
): bool|string

Get the raw XFA (XML/XMP) data from the PDF document.

getXmp()

public SetaPDF_FormFiller_Xfa::getXmp (
void
): bool|string

Get the raw XFA (XML/XMP) from the PDF document.

See

isDynamic()

public SetaPDF_FormFiller_Xfa::isDynamic (
void
): bool

Checks if the XFA form is a dynamic or static form.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Type_Exception

saveFormNode()

public SetaPDF_FormFiller_Xfa::saveFormNode (
void
): bool

Saves the form node to the XFA packages.

Exceptions

Throws SetaPDF_FormFiller_Exception

Throws SetaPDF_Core_SecHandler_Exception

saveTemplate()

public SetaPDF_FormFiller_Xfa::saveTemplate (
[ boolean $onlyIfUpdated = false ]
): bool

Saves the template node to the PDF structure.

Parameters
$onlyIfUpdated : boolean

Save only if the template node was updated internally.

setData()

public SetaPDF_FormFiller_Xfa::setData (
null|string $xml
): void

Set the content of the data node.

Parameters
$xml : null|string
 
Exceptions

Throws SetaPDF_FormFiller_Exception

Throws Exception

setDefaultValue()

public SetaPDF_FormFiller_Xfa::setDefaultValue (
string $fieldName, mixed $value [, string $encoding = 'UTF-8' ]
): boolean

Set the default value for a specific field.

Parameters
$fieldName : string
 
$value : mixed
 
$encoding : string
 

setReadOnly()

public SetaPDF_FormFiller_Xfa::setReadOnly (
string $fieldName, bool $readOnly
): bool

Set a field to read-only or to "open".

This method is called internally by the SetaPDF_FormFiller_Field_AbstractField::setReadOnly() method.

Parameters
$fieldName : string
 
$readOnly : bool
 

setValue()

public SetaPDF_FormFiller_Xfa::setValue (
string $fieldName, mixed $value [, string $encoding = 'UTF-8' ]
): bool

Sets a value by a field name.

This method is called internally if a fields value is changed to keep the XML data in sync. It should be used manually with care.

Parameters
$fieldName : string
 
$value : mixed
 
$encoding : string
 

setXml()

public SetaPDF_FormFiller_Xfa::setXml (
DOMDocument|string $domDocumentOrXml
): void

Set the raw XFA (XML/XMP) structure.

Parameters
$domDocumentOrXml : DOMDocument|string
 
Exceptions

Throws SetaPDF_FormFiller_Exception

setXmp()

public SetaPDF_FormFiller_Xfa::setXmp (
DOMDocument|string $domDocumentOrXml
): void

Set the raw XFA (XML/XMP) structure.

Parameters
$domDocumentOrXml : DOMDocument|string
 
See

syncAcroFormFields()

public SetaPDF_FormFiller_Xfa::syncAcroFormFields (
void
): void

Syncornizes the XFA form field values with the corresponding AcroForm fields.

If XML data were passed via the SetaPDF_FormFiller_Xfa::setData() method this method will ensure that the data in the corresponding AcroForm fields representations will get updated.

syncDataNode()

public SetaPDF_FormFiller_Xfa::syncDataNode (
void
): bool

Writes the data node back to the PDF document.


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