Class SetaPDF_FormFiller in SetaPDF v2 API Reference

Index

\SetaPDF
1. FormFiller
2. FormFiller

SetaPDF_FormFiller The main class of the SetaPDF-FormFiller Component

File: /SetaPDF v2/FormFiller.php

Class hierarchy

SetaPDF_FormFiller

Summary

Constants

VERSION

public const string SetaPDF_FormFiller::VERSION = '2.45.0.1963'

Version

Properties

$_document

protected SetaPDF_Core_Document SetaPDF_FormFiller::$_document

The document instance

$_fields

protected SetaPDF_FormFiller_Fields SetaPDF_FormFiller::$_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

protected SetaPDF_FormFiller_Xfa SetaPDF_FormFiller::$_xfa

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

Methods

__construct()

public SetaPDF_FormFiller::__construct (

SetaPDF_Core_Document $document

)

The constructor.

Parameters

$document : SetaPDF_Core_Document: The document instance

cleanUp()

public SetaPDF_FormFiller::cleanUp (

void

): 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

): SetaPDF_Core_Document

Get the document instance.

getFields()

public SetaPDF_FormFiller::getFields (

void

): SetaPDF_FormFiller_Fields

Get the fields collection object.

getRemoveXfaInformation()

public SetaPDF_FormFiller::getRemoveXfaInformation (

void

): boolean

Get the flag how to handling XFA information.

getXfa()

public SetaPDF_FormFiller::getXfa (

void

): bool|SetaPDF_FormFiller_Xfa

Get the XFA helper object.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

isNeedAppearancesSet()

public SetaPDF_FormFiller::isNeedAppearancesSet (

void

): boolean

Checks if the NeedAppearances flag is set or not.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

save()

WARNING: This method is marked as deprecated!

Deprecated since version 2.5

public SetaPDF_FormFiller::save (

[ boolean $update = true ]

): void

Save the document.

A proxy method to the documents save() method.

Parameters

$update : boolean: Update the document or rewrite it completely

Exceptions

Throws SetaPDF_Core_Document_ObjectNotDefinedException

Throws SetaPDF_Core_Document_ObjectNotFoundException

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_Parser_CrossReferenceTable_Exception

Throws SetaPDF_Core_Parser_Exception

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Type_IndirectReference_Exception

Throws SetaPDF_Exception

Throws SetaPDF_Exception_NotImplemented

See

SetaPDF_Core_Document::save()

setNeedAppearances()

public SetaPDF_FormFiller::setNeedAppearances (

[ boolean $needAppearances = true ]

): void

Set the NeedAppearances flag.

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

Parameters

$needAppearances : boolean: The NeedAppearances flag status

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

setRemoveXfaInformation()

public SetaPDF_FormFiller::setRemoveXfaInformation (

boolean $removeXfaInformation

): void

Set the flag for handling XFA information.

Parameters

$removeXfaInformation : boolean: The RemoveXfaInformation flag status