SetaPDF_FormFiller_Xfa Class offering access to XFA data of a PDF form.
File: /SetaPDF v2/FormFiller/Xfa.php
Class hierarchy
Summary
Methods
- __construct()
- _evaluateValue()
- _findPacketStream()
- _setValueInForm()
- cleanUp()
- getBridge()
- getData()
- getDomDocument()
- getFormFiller()
- getFormNode()
- getFormNodeChecksum()
- getObject()
- getTemplate()
- getXml()
- getXmp()
- isDynamic()
- saveFormNode()
- saveTemplate()
- setData()
- setDefaultValue()
- setReadOnly()
- setValue()
- setXml()
- setXmp()
- syncAcroFormFields()
- syncDataNode()
Properties
$_data
The data node.
$_domDocument
The document instance of the full XDP packet.
$_form
The form node.
$_formFiller
The form filler instance
$_template
The template node.
Methods
__construct()
_evaluateValue()
Evaluates a native value to a data value.
Parameters
- $value : mixed
- $fieldNode : DOMElement
_findPacketStream()
Finds a packets stream by its name.
Parameters
- $array : SetaPDF_Core_Type_Array
- $name : string
- $create : boolean
_setValueInForm()
Creates the data node and sets the value in the form package.
Parameters
- $fieldName : string
- $value : mixed
Exceptions
Throws SetaPDF_FormFiller_Exception
getBridge()
getDomDocument()
getFormNode()
getFormNodeChecksum()
getTemplate()
saveFormNode()
saveTemplate()
Saves the template node to the PDF structure.
Parameters
- $onlyIfUpdated : boolean
Save only if the template node was updated internally.
setData()
Set the content of the data node.
Parameters
- $xml : null|string
Exceptions
Throws SetaPDF_FormFiller_Exception
Throws Exception
setDefaultValue()
Set the default value for a specific field.
Parameters
- $fieldName : string
- $value : mixed
- $encoding : string
setReadOnly()
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()
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()
Set the raw XFA (XML/XMP) structure.
Parameters
- $domDocumentOrXml : DOMDocument|string
Exceptions
Throws SetaPDF_FormFiller_Exception
setXmp()
syncAcroFormFields()
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.