SetaPDF_Core_Document_Catalog_AcroForm Class representing a basic AcroForm

File: /SetaPDF v2/Core/Document/Catalog/AcroForm.php

Class hierarchy

Summary

Properties

$_catalog

The documents catalog instance

$_dictionary


Static Methods

resolveFieldName()

public static SetaPDF_Core_Document_Catalog_AcroForm::resolveFieldName (
SetaPDF_Core_Type_Dictionary $terminalFieldDictionary [, boolean $asArray = false ]
): string

Resolves the qualified name of a form field.

Parameters
$terminalFieldDictionary : SetaPDF_Core_Type_Dictionary

The terminal field of the form field

$asArray : boolean
 

Methods

__construct()

_readTerminalFieldsObjects()

private SetaPDF_Core_Document_Catalog_AcroForm::_readTerminalFieldsObjects (
array|null $fields, array &$objects
): void

Read all terminal fields objects.

Parameters
$fields : array|null
 
$objects : array
 

addDefaultEntriesAndValues()

Add default values and resources to the AcroForm dictionary.

This is needed to avoid undefined behavior in adobe reader. If for example base fonts are missing, the file is digital signed and include links, the signature panel will never be displayed.

cleanUp()

Release cycled references.

getCalculationOrderArray()

Get and creates the calculation order array.

Parameters
$create : boolean
 

getDefaultResources()

public SetaPDF_Core_Document_Catalog_AcroForm::getDefaultResources (
[ bool $create = false [, null $entryKey = null ]]
): array|bool|SetaPDF_Core_Type_Dictionary

Get the default resources of the AcroForm.

Parameters
$create : bool
 
$entryKey : null
 

getDictionary()

Get and creates the AcroForm dictionary.

Parameters
$create : boolean
 

getDocument()

getFieldsArray()

Get and creates the fields array.

Parameters
$create : boolean
 

getTerminalFieldsObjects()

isNeedAppearancesSet()

Checks if the NeedAppearances flag is set or not.

isXfaForm()

Checks if a XFA key is present.

removeXfaInformation()

Removes the XFA entry if present.

setNeedAppearances()

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

Set the NeedAppearances flag.

This flag indicates the viewer to rerender the form field appearances.

Parameters
$needAppearances : boolean