SetaPDF_FormFiller The main class of the SetaPDF-FormFiller Component

File: /SetaPDF v2/FormFiller.php

Class hierarchy

Summary

Constants

VERSION

public const string SetaPDF_FormFiller::VERSION = '2.39.0.1706'

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 SetaPDF_FormFiller::cleanUp (
void
):

Release objects to free memory and cycled references.

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

getDocument()

public SetaPDF_FormFiller::getDocument (
void
):

Get the document instance.

getFields()

public SetaPDF_FormFiller::getFields (
void
):

Get the fields collection object.

getRemoveXfaInformation()

Get the flag how to handling XFA information.

getXfa()

public SetaPDF_FormFiller::getXfa (
void
):

Get the XFA helper object.

isNeedAppearancesSet()

Checks if the NeedAppearances flag is set or not.

save()

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

Save the document.

A proxy method to the documents save() method.

Parameters
$update

Update the document or rewrite it completely

See

setNeedAppearances()

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

Set the NeedAppearances flag.

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

Parameters
$needAppearances

The NeedAppearances flag status

setRemoveXfaInformation()

public SetaPDF_FormFiller::setRemoveXfaInformation (
$removeXfaInformation
): void

Set the flag for handling XFA information.

Parameters
$removeXfaInformation

The RemoveXfaInformation flag status