setasign\SetaPDF2\FormFiller\Field\FlattenTaggingHandler
AbstractFlattenTaggingHandler An abstract tagging handler for flattened form fields.
File: /SetaPDF v2/FormFiller/Field/FlattenTaggingHandler/AbstractFlattenTaggingHandler.php
The class comes with several helper methods, that could be needed/used by real handler implementations.
Class hierarchy
Summary
Properties
$_callback
protected ?callable AbstractFlattenTaggingHandler::$_callback
Static Methods
ensureAttributeDictionaryByOwner()
public static AbstractFlattenTaggingHandler::ensureAttributeDictionaryByOwner (): \setasign\SetaPDF2\Core\Type\PdfDictionary
Helper method that ensures a dictionary by an owner name.
Parameters
- $structElemDict: \setasign\SetaPDF2\Core\Type\PdfDictionary
- $owner: string
Methods
__construct()
public AbstractFlattenTaggingHandler::__construct (
?callable(
\setasign\SetaPDF2\FormFiller\Field\AbstractField $field, \setasign\SetaPDF2\Core\Type\IndirectObjectInterface $parentObject
): bool $callback = null
)\setasign\SetaPDF2\FormFiller\Field\AbstractField $field, \setasign\SetaPDF2\Core\Type\IndirectObjectInterface $parentObject
): bool $callback = null
Parameters
- $callback: ?callable(
\setasign\SetaPDF2\FormFiller\Field\AbstractField $field, \setasign\SetaPDF2\Core\Type\IndirectObjectInterface $parentObject
): bool A callback that allows you to access/modify the parent structure element during the flattening process. If it returns true, the internal
_updateAttributes()method is executed. If false, it is not executed.
_ensureStructureInformation()
protected AbstractFlattenTaggingHandler::_ensureStructureInformation (
\setasign\SetaPDF2\FormFiller\Field\AbstractField $field,
?int &$structParent,
?\setasign\SetaPDF2\Core\Type\PdfDictionary &$structElem,
?\setasign\SetaPDF2\Core\Document\Catalog\StructTreeRoot &$structTreeRoot,
?\setasign\SetaPDF2\Core\DataStructure\Tree\NumberTree &$parentTree,
?\setasign\SetaPDF2\Core\Type\PdfIndirectObject &$parentObject
): bool?int &$structParent,
?\setasign\SetaPDF2\Core\Type\PdfDictionary &$structElem,
?\setasign\SetaPDF2\Core\Document\Catalog\StructTreeRoot &$structTreeRoot,
?\setasign\SetaPDF2\Core\DataStructure\Tree\NumberTree &$parentTree,
?\setasign\SetaPDF2\Core\Type\PdfIndirectObject &$parentObject
Helper method, that initiates variables for working with the structure element related to a form field.
Parameters
- $field: \setasign\SetaPDF2\FormFiller\Field\AbstractField
- $structParent: ?int
- $structElem: ?\setasign\SetaPDF2\Core\Type\PdfDictionary
- $structTreeRoot: ?\setasign\SetaPDF2\Core\Document\Catalog\StructTreeRoot
- $parentTree: ?\setasign\SetaPDF2\Core\DataStructure\Tree\NumberTree
- $parentObject: ?\setasign\SetaPDF2\Core\Type\PdfIndirectObject
Exceptions
_updateAttributes()
protected AbstractFlattenTaggingHandler::_updateAttributes (
\setasign\SetaPDF2\FormFiller\Field\AbstractField $field,
\setasign\SetaPDF2\Core\Type\IndirectObjectInterface $parentObject
): void\setasign\SetaPDF2\Core\Type\IndirectObjectInterface $parentObject
Updates attributes by the individual form field instances.
Parameters
- $field: \setasign\SetaPDF2\FormFiller\Field\AbstractField
- $parentObject: \setasign\SetaPDF2\Core\Type\IndirectObjectInterface
Exceptions
Throws \setasign\SetaPDF2\Core\Type\Exception