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

File: /SetaPDF/FormFiller/Xfa.php

Class hierarchy

Summary

Properties

$_bridge

$_data

The data node.

$_dataNodeUpdated

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

$_domDocument

The document instance of the full XDP packet.

$_formFiller

The form filler instance

$_setValueIsActive

Flag identicating that a setValue() process is working.

$_template

The template node.

$_templateNodeUpdated

Flag indicating that the template node was changed.


Methods

__construct()

The constructor.

Parameters
$formFiller : SetaPDF_FormFiller

The form filler instance

_evaluateValue()

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

Evaluates a native value to a data value.

Parameters
$value : $value
 
$fieldNode : DOMElement
 

_findPacketStream()

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

Finds a packets stream by its name.

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

_getBridge()

Get the XFA bridge helper object.

Exceptions

Throws SetaPDF_FormFiller_Exception

cleanUp()

public void SetaPDF_FormFiller_Xfa::cleanUp ( void )

Releases memory and resources.

deleteField()

public bool SetaPDF_FormFiller_Xfa::deleteField ( string $fieldName [, bool $reset = true ] )

Delete a field in the template structure.

This method is called internally by the delete() method of an AcroForm field representation. This will also be the case if a field is flattened.

Parameters
$fieldName : string
 
$reset : bool
 
See

getData()

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

Get the data node.

Parameters
$create : bool
 

getDomDocument()

Get the DOMDocument instance of the XFA structure.

Exceptions

Throws SetaPDF_FormFiller_Exception

getFormFiller()

Get the form filler instance.

getObject()

Get the XFA pdf object.

getTemplate()

Gets the template node from the XFA structure.

Exceptions

Throws SetaPDF_FormFiller_Exception

getXml()

public bool|string SetaPDF_FormFiller_Xfa::getXml ( void )

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

getXmp()

public bool|string SetaPDF_FormFiller_Xfa::getXmp ( void )

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

See

isDynamic()

public bool SetaPDF_FormFiller_Xfa::isDynamic ( void )

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

saveTemplate()

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

Saves the template node to the PDF structure.

Parameters
$onlyIfUpdated : boolean

Save only if the template node was updated internally.

setData()

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

Set the content of the data node.

Parameters
$xml : null|string
 
Exceptions

Throws SetaPDF_FormFiller_Exception, Exception

setDefaultValue()

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

Set the default value for a specific field.

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

setReadOnly()

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

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

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

Parameters
$fieldName : $fieldName
 
$readOnly : $readOnly
 

setValue()

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

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 void SetaPDF_FormFiller_Xfa::setXml ( DOMDocument|string $domDocumentOrXml )

Set the raw XFA (XML/XMP) structure.

Parameters
$domDocumentOrXml : DOMDocument|string
 
Exceptions

Throws SetaPDF_FormFiller_Exception

setXmp()

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

Set the raw XFA (XML/XMP) structure.

Parameters
$domDocumentOrXml : DOMDocument|string
 
See

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.

syncDataNode()

public bool SetaPDF_FormFiller_Xfa::syncDataNode ( void )

Writes the data node back to the PDF document.