SetaPDF_FormFiller_Fields Class allowing transparent access to form fields of a PDF document
File: /SetaPDF v2/FormFiller/Fields.php
Class hierarchy
Implements
Summary
Methods
- __construct()
- _readFormFields()
- beforeFieldFlattenOrDelete()
- cleanUp()
- count()
- current()
- delete()
- ensureIndividualAppearanceStreams()
- flatten()
- forwardValueToRelated()
- get()
- getAll()
- getFormFiller()
- getNames()
- getRelatedFieldNames()
- getRelatedFields()
- isForwardValueActive()
- key()
- next()
- offsetExists()
- offsetGet()
- offsetSet()
- offsetUnset()
- onFieldDeleted()
- release()
- rewind()
- valid()
Properties
$_handleAllFieldsActive
Defines whether a delete or flatten action is done for all available fields.
Methods
__construct()
beforeFieldFlattenOrDelete()
This method is called before a field is deleted.
Parameters
delete()
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
ensureIndividualAppearanceStreams()
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.
flatten()
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 : boolean
Defines whether the field appearance is re-created if the NeedAppearances flag is set.
forwardValueToRelated()
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
get()
Gets a single field by field name.
Parameters
- $name : string
The name of the field
- $cache : boolean
Cache the field instance in the fields object.
Exceptions
Throws SetaPDF_FormFiller_Exception
getAll()
Get all available field objects.
Parameters
- $cache : boolean
Cache the field instance in the fields object.
getRelatedFieldNames()
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 : boolean
Left the origin passed field in the resulting array or not
getRelatedFields()
Get all same named/related form fields.
Parameters
- $field : SetaPDF_FormFiller_Field_FieldInterface|string
The initial field
- $leftOriginField : boolean
Left the origin passed field in the resulting array or not
offsetExists()
Implementation of the ArrayAccess interface.
Parameters
- $offset : string
An offset to check for
offsetGet()
Implementation of the ArrayAccess interface.
Parameters
- $offset : string
The offset to retrieve
offsetSet()
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()
Implementation of the ArrayAccess interface.
Parameters
- $offset : string
The offset to unset
onFieldDeleted()
This method is called when a field is deleted.
Parameters
- $field : SetaPDF_FormFiller_Field_FieldInterface
The field instance that is deleted
release()
Releases the cached instance of the field.
Parameters
- $name : string
The field name.
Return Values
Whether the cached instance was removed or not.