setasign\SetaPDF2\FormFiller

FormFiller The main class of the SetaPDF-FormFiller Component

File: /SetaPDF v2/FormFiller/FormFiller.php
Old class name (alias): \SetaPDF_FormFiller

Class hierarchy

Summary

Constants

VERSION

public const string FormFiller::VERSION = '2.48.0.2155'

Version


Properties

$_document

The document instance

$_fields

The object representing the form fields collection

$_removeXfaInformation

protected bool FormFiller::$_removeXfaInformation = false

Flag defining how to handle XFA information if found

$_xfa

protected Xfa FormFiller::$_xfa

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


Methods

__construct()

The constructor.

Parameters
$document : \setasign\SetaPDF2\Core\Document

The document instance

cleanUp()

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

public FormFiller::getFields (
void
): Fields

Get the fields collection object.

getRemoveXfaInformation()

public FormFiller::getRemoveXfaInformation (
void
): bool

Get the flag how to handling XFA information.

getXfa()

public FormFiller::getXfa (
void
): bool|Xfa

Get the XFA helper object.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

isNeedAppearancesSet()

public FormFiller::isNeedAppearancesSet (
void
): bool

Checks if the NeedAppearances flag is set or not.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

save()

WARNING: This method is marked as deprecated!

Deprecated since version 2.5

public FormFiller::save (
bool $update = true
): void

Save the document.

A proxy method to the documents save() method.

Parameters
$update : bool

Update the document or rewrite it completely

Exceptions

Throws \setasign\SetaPDF2\Core\Document\ObjectNotDefinedException

Throws \setasign\SetaPDF2\Core\Document\ObjectNotFoundException

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\Parser\CrossReferenceTable\Exception

Throws \setasign\SetaPDF2\Core\Parser\Exception

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Core\Type\IndirectReference\Exception

Throws \setasign\SetaPDF2\Exception

Throws \setasign\SetaPDF2\NotImplementedException

See

setNeedAppearances()

public FormFiller::setNeedAppearances (
bool $needAppearances = true
): void

Set the NeedAppearances flag.

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

Parameters
$needAppearances : bool

The NeedAppearances flag status

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

setRemoveXfaInformation()

public FormFiller::setRemoveXfaInformation (
bool $removeXfaInformation
): void

Set the flag for handling XFA information.

Parameters
$removeXfaInformation : bool

The RemoveXfaInformation flag status