SetaPDF_FormFiller The main class of the SetaPDF-FormFiller Component

File: /SetaPDF/FormFiller.php

Class hierarchy

Summary

Constants

VERSION

const string SetaPDF_FormFiller::VERSION = '2.24.0.1049'

Version


Properties

$_document

The document instance

$_fields

The object representing the form fields collection

$_removeXfaInformation

protected boolean SetaPDF_FormFiller::$_removeXfaInformation = false

Flag defining how to handle XFA information if found

$_xfa

An instance allowing access to the XFA data of a form.


Methods

__construct()

The constructor.

Parameters
$document : SetaPDF_Core_Document

The document instance

cleanUp()

public void SetaPDF_FormFiller::cleanUp ( void )

Release objects to free memory and cycled references.

After calling this method the instance of this object is unusable.

getDocument()

Get the document instance.

getFields()

Get the fields collection object.

getRemoveXfaInformation()

Get the flag how to handling XFA information.

getXfa()

Get the XFA helper object.

isNeedAppearancesSet()

public boolean SetaPDF_FormFiller::isNeedAppearancesSet ( void )

Checks if the NeedAppearances flag is set or not.

save()

public void SetaPDF_FormFiller::save ( [ boolean $update = true ] )

Save the document.

A proxy method to the documents save() method.

Parameters
$update : boolean

Update the document or rewrite it completely

See

setNeedAppearances()

public void SetaPDF_FormFiller::setNeedAppearances ( [ boolean $needAppearances = true ] )

Set the NeedAppearances flag.

This flag indicates the viewer to re-render the form field appearances.

Parameters
$needAppearances : boolean

The NeedAppearances flag status

setRemoveXfaInformation()

public void SetaPDF_FormFiller::setRemoveXfaInformation ( boolean $removeXfaInformation )

Set the flag for handling XFA information.

Parameters
$removeXfaInformation : boolean

The RemoveXfaInformation flag status