Index

  1. \SetaPDF
    1. Core
    2. Core
      1. Document
      2. Document
        1. Catalog
        2. Catalog
          1. Names
          2. Names
          3. AcroForm
          4. AdditionalActions
          5. Dests
          6. Extensions
          7. MarkInfo
          8. OptionalContent
          9. Outlines
          10. OutputIntents
          11. PageLabels
          12. Pages
          13. Permissions
          14. StructTreeRoot
          15. ViewerPreferences

SetaPDF_Core_Document_Catalog_AcroForm Class representing a basic AcroForm

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

Class hierarchy

Summary

Static Methods

Methods

Properties

Properties

$_catalog

protected SetaPDF_Core_Document SetaPDF_Core_Document_Catalog_AcroForm::$_catalog

The documents catalog instance

$_dictionary

protected SetaPDF_Core_Type_Dictionary SetaPDF_Core_Document_Catalog_AcroForm::$_dictionary

The AcroForm dictionary


Static Methods

resolveFieldName()

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

Resolves the qualified name of a form field.

Parameters
$terminalFieldDictionary : SetaPDF_Core_Type_Dictionary

The terminal field of the form field

$asArray : boolean
 
Return Values

In UTF-8 encoding

Exceptions

Throws SetaPDF_Core_Type_Exception


Methods

__construct()

public SetaPDF_Core_Document_Catalog_AcroForm::__construct ()

The constructor.

Parameters
$catalog : SetaPDF_Core_Document_Catalog
 

_readTerminalFieldsObjects()

private SetaPDF_Core_Document_Catalog_AcroForm::_readTerminalFieldsObjects (
[ SetaPDF_Core_Type_Array|null $fields = null [, SetaPDF_Core_Type_IndirectObjectInterface[] &$objects = null ]]
): void

Read all terminal fields objects.

Parameters
$fields : SetaPDF_Core_Type_Array|null
 
$objects : SetaPDF_Core_Type_IndirectObjectInterface[]
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Type_IndirectReference_Exception

addDefaultEntriesAndValues()

public SetaPDF_Core_Document_Catalog_AcroForm::addDefaultEntriesAndValues (
void
): void

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.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

addResource()

public SetaPDF_Core_Document_Catalog_AcroForm::addResource (): string

Adds a resource.

Parameters
$type : string|SetaPDF_Core_Resource
 
$object : null|SetaPDF_Core_Resource|SetaPDF_Core_Type_IndirectObjectInterface
 
Exceptions

Throws InvalidArgumentException

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

cleanUp()

public SetaPDF_Core_Document_Catalog_AcroForm::cleanUp (
void
): void

Release cycled references.

delete()

public SetaPDF_Core_Document_Catalog_AcroForm::delete (): void

Deletes a field by its terminal field object.

Make sure that you only pass an object that was really resolved from this instance. There are no internal checks which validates the object content but a simple check for an FT value.

ALSO NOTE: This method will NOT remove the reference from the Annotations entry of a page but only in entries in the AcroForm structure (Fields and CO).

Parameters
$terminalFieldObject : SetaPDF_Core_Type_IndirectObjectInterface
 
Exceptions

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_IndirectReference_Exception

getCalculationOrderArray()

public SetaPDF_Core_Document_Catalog_AcroForm::getCalculationOrderArray (
[ boolean $create = false ]
): SetaPDF_Core_Type_Array|false

Get and creates the calculation order array.

Parameters
$create : boolean
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getDefaultResources()

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

Get the default resources of the AcroForm.

Parameters
$create : bool
 
$entryKey : null
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getDictionary()

public SetaPDF_Core_Document_Catalog_AcroForm::getDictionary (
[ boolean $create = false ]
): boolean|SetaPDF_Core_Type_Dictionary

Get and creates the AcroForm dictionary.

Parameters
$create : boolean
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getDocument()

public SetaPDF_Core_Document_Catalog_AcroForm::getDocument (
void
): SetaPDF_Core_Document

Get the document instance.

getFieldsArray()

public SetaPDF_Core_Document_Catalog_AcroForm::getFieldsArray (
[ boolean $create = false ]
): SetaPDF_Core_Type_Array|false

Get and creates the fields array.

Parameters
$create : boolean
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getTerminalFieldsObjects()

public SetaPDF_Core_Document_Catalog_AcroForm::getTerminalFieldsObjects (
void
): SetaPDF_Core_Type_IndirectObjectInterface[]

Get the terminal fields objects of a document.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_IndirectReference_Exception

Throws SetaPDF_Core_Type_Exception

isNeedAppearancesSet()

public SetaPDF_Core_Document_Catalog_AcroForm::isNeedAppearancesSet (
void
): boolean

Checks if the NeedAppearances flag is set or not.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

isXfaForm()

public SetaPDF_Core_Document_Catalog_AcroForm::isXfaForm (
void
): boolean

Checks if a XFA key is present.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

removeXfaInformation()

public SetaPDF_Core_Document_Catalog_AcroForm::removeXfaInformation (
void
): bool

Removes the XFA entry if present.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

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
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception


© 2024 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)