Index

  1. \setasign\SetaPDF2
    1. FormFiller
      1. Exception
      2. Field
      3. Fields
      4. FormFiller
      5. Xfa
      6. Xfa

setasign\SetaPDF2\FormFiller

Fields Class allowing transparent access to form fields of a PDF document

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

Class hierarchy

Implements

Summary

Methods

Properties

Properties

$_fieldObjects

protected array Fields::$_fieldObjects = array()

The pdf object of each form field / collection (at PDF level)

$_fields

protected \SetaPDF_FormFiller_Field_FieldInterface[] Fields::$_fields = array()

The field instances

$_fieldsRead

protected bool Fields::$_fieldsRead = false

Flag defines that the fields are read from the document

$_formFiller

protected \SetaPDF_FormFiller Fields::$_formFiller

The form filler instance

$_forwardValue

protected bool Fields::$_forwardValue = false

Flag defines that the forwarding of setValue calls is active

$_handleAllFieldsActive

protected bool Fields::$_handleAllFieldsActive = false

Defines whether a delete or flatten action is done for all available fields.

$_relatedFields

protected array Fields::$_relatedFields = array()

An array of names of related fields


Methods

__construct()

public Fields::__construct (
\SetaPDF_FormFiller $formFiller
)

The constructor.

Parameters
$formFiller : \SetaPDF_FormFiller

The form filler instance

_readFormFields()

protected Fields::_readFormFields (
void
): void

Reads the form field objects and prepares them for later usage.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

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

beforeFieldFlattenOrDelete()

public Fields::beforeFieldFlattenOrDelete (): void

This method is called before a field is deleted.

Parameters
$field : \SetaPDF_FormFiller_Field_FieldInterface
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

cleanUp()

public Fields::cleanUp (
void
): void

Releases memory and resources.

count()

public Fields::count (
void
): int

Implementation of Countable.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

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

current()

public Fields::current (
void
): \SetaPDF_FormFiller_Field_FieldInterface

Implementation of the Iterator interface.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

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

Throws Exception

delete()

public Fields::delete (
null|string|\SetaPDF_FormFiller_Field_FieldInterface $field = null
): void

Delete a field.

Parameters
$field : null|string|\SetaPDF_FormFiller_Field_FieldInterface

The name or an instance of the field, or null to delete all fields

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

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

Throws Exception

Throws Field\Exception

ensureIndividualAppearanceStreams()

public Fields::ensureIndividualAppearanceStreams (
void
): int

Ensure that each field have it's own appearance stream.

Some PDFs share the appearance stream in different fields (e.g. for empty fields). This would make it impossible to fill these fields individually. This method checks for such fields and "repairs" them by creating a new empty appearance stream.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

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

Throws Exception

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

flatten()

public Fields::flatten (
null|string|\SetaPDF_FormFiller_Field_FieldInterface $field = null,
bool $recreateAppearanceIfNeedAppearancesIsSet = false
): void

Flatten a field to the pages content stream.

Parameters
$field : null|string|\SetaPDF_FormFiller_Field_FieldInterface

The name or an instance of the field, or null to flatten all fields

$recreateAppearanceIfNeedAppearancesIsSet : bool

Defines whether the field appearance is re-created if the NeedAppearances flag is set.

Exceptions

Throws \setasign\SetaPDF2\Core\Document\ObjectNotFoundException

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\Parser\Pdf\InvalidTokenException

Throws \setasign\SetaPDF2\Core\Reader\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

Throws Exception

forwardValueToRelated()

public Fields::forwardValueToRelated (
mixed $value,
\SetaPDF_FormFiller_Field_FieldInterface $field,
string $encoding = 'UTF-8',
string $method = 'setValue'
): void

This method forwards a setValue call to related/same named form fields.

Parameters
$value : mixed

The value

$field : \SetaPDF_FormFiller_Field_FieldInterface

The initial form field, which was changed

$encoding : string

The encoding of the value

$method : string

The method that forwards the value

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

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

Throws Exception

get()

public Fields::get (
string $name,
bool $cache = true
): \SetaPDF_FormFiller_Field_FieldInterface

Gets a single field by field name.

Parameters
$name : string

The name of the field

$cache : bool

Cache the field instance in the fields object.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

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

Throws Exception

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

getAll()

public Fields::getAll (
bool $cache = true
): \SetaPDF_FormFiller_Field_FieldInterface[]

Get all available field objects.

Parameters
$cache : bool

Cache the field instance in the fields object.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

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

Throws Exception

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

getFormFiller()

public Fields::getFormFiller (
void
): \SetaPDF_FormFiller

Get the form filler instance.

getNames()

public Fields::getNames (
void
): string[]

Get all available field names.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

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

getRelatedFieldNames()

public Fields::getRelatedFieldNames (
string|\SetaPDF_FormFiller_Field_FieldInterface $field,
bool $leftOriginFieldName = true
): string[]

Get all names of related form fields.

Parameters
$field : string|\SetaPDF_FormFiller_Field_FieldInterface

The name or an instance to get related form fields

$leftOriginFieldName : bool

Left the origin passed field in the resulting array or not

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

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

Throws Exception

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

getRelatedFields()

public Fields::getRelatedFields (
\SetaPDF_FormFiller_Field_FieldInterface|string $field,
bool $leftOriginField = true
): \SetaPDF_FormFiller_Field_FieldInterface[]

Get all same named/related form fields.

Parameters
$field : \SetaPDF_FormFiller_Field_FieldInterface|string

The initial field

$leftOriginField : bool

Left the origin passed field in the resulting array or not

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

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

Throws Exception

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

isForwardValueActive()

public Fields::isForwardValueActive (
void
): bool

Returns whether the "forwarding"-flag is set active.

key()

public Fields::key (
void
): ?string

Implementation of the Iterator interface.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

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

next()

public Fields::next (
void
): void

Implementation of the Iterator interface.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

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

offsetExists()

public Fields::offsetExists (
string $offset
): bool

Implementation of the ArrayAccess interface.

Parameters
$offset : string

An offset to check for

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

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

offsetGet()

public Fields::offsetGet (
string $offset
): \SetaPDF_FormFiller_Field_FieldInterface

Implementation of the ArrayAccess interface.

Parameters
$offset : string

The offset to retrieve

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

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

Throws Exception

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

offsetSet()

public Fields::offsetSet (
string $offset,
mixed $value
): void

Implementation of the ArrayAccess interface.

Parameters
$offset : string

The offset to assign the value to

$value : mixed

The value to set

Exceptions

Throws \BadMethodCallException

offsetUnset()

public Fields::offsetUnset (
string $offset
): void

Implementation of the ArrayAccess interface.

Parameters
$offset : string

The offset to unset

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

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

Throws Exception

Throws Field\Exception

onFieldDeleted()

public Fields::onFieldDeleted (): void

This method is called when a field is deleted.

Parameters
$field : \SetaPDF_FormFiller_Field_FieldInterface

The field instance that is deleted

release()

public Fields::release (
string $name
): bool

Releases the cached instance of the field.

Parameters
$name : string

The field name.

Return Values

Whether the cached instance was removed or not.

rewind()

public Fields::rewind (
void
): void

Implementation of the Iterator interface.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

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

valid()

public Fields::valid (
void
): bool

Implementation of the Iterator interface.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

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


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