SetaPDF v2 API Reference

Index

\setasign\SetaPDF2
1. Merger
  1. Handler
    1. FormFields
    2. Names
    3. OptionalContent
    4. Outlines
    5. Tags

setasign\SetaPDF2\Merger\Handler

FormFields

File: /SetaPDF v2/Merger/Handler/FormFields.php

Class hierarchy

FormFields

Summary

Methods

__construct()
_copyDefaultResources()
_handleAcroFormsByMergingSameNamedFields()
_handleAcroFormsByRenamingSameNamedFields()
_removeFormFieldFromFieldTree()
handle()
setRenameSameNamedFormFields()

Properties

$_merger
$_renameSameNamedFormFields

Properties

$_merger

protected \setasign\SetaPDF2\Merger\Merger FormFields::$_merger

$_renameSameNamedFormFields

protected bool FormFields::$_renameSameNamedFormFields = true

Flag saying if same named form fields should be renamed.

Methods

__construct()

public FormFields::__construct (

\setasign\SetaPDF2\Merger\Merger $merger

)

Parameters

$merger : \setasign\SetaPDF2\Merger\Merger

_copyDefaultResources()

protected FormFields::_copyDefaultResources (

\setasign\SetaPDF2\Core\Document\Catalog\AcroForm $acroForm,
\setasign\SetaPDF2\Core\Document\Catalog\AcroForm $resAcroForm,
\setasign\SetaPDF2\Core\Document $resDocument

): void

Helper method that copies the default resources in the AcroForm dictionary.

Parameters

$acroForm : \setasign\SetaPDF2\Core\Document\Catalog\AcroForm
$resAcroForm : \setasign\SetaPDF2\Core\Document\Catalog\AcroForm
$resDocument : \setasign\SetaPDF2\Core\Document

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

_handleAcroFormsByMergingSameNamedFields()

protected FormFields::_handleAcroFormsByMergingSameNamedFields (

array $touchedPdfs,
array $documents

): void

Handles AcroForm data by merging same named form fields.

Parameters

$touchedPdfs : array
$documents : array

Exceptions

Throws \setasign\SetaPDF2\Core\Document\ObjectNotFoundException

Throws \setasign\SetaPDF2\Merger\Exception

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Exception

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

Throws \setasign\SetaPDF2\Core\Reader\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

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

Throws \setasign\SetaPDF2\Core\Type\IndirectReference\RecursionException

Throws \setasign\SetaPDF2\Exception

Throws \setasign\SetaPDF2\NotImplementedException

_handleAcroFormsByRenamingSameNamedFields()

protected FormFields::_handleAcroFormsByRenamingSameNamedFields (

array $touchedPdfs,
array $documents

): void

Handles AcroForm data by renaming same named form fields.

Parameters

$touchedPdfs : array
$documents : array

Exceptions

Throws \setasign\SetaPDF2\Core\Document\ObjectNotFoundException

Throws \setasign\SetaPDF2\Merger\Exception

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Exception

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

Throws \setasign\SetaPDF2\Core\Reader\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

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

Throws \setasign\SetaPDF2\Core\Type\IndirectReference\RecursionException

Throws \setasign\SetaPDF2\Exception

Throws \setasign\SetaPDF2\NotImplementedException

_removeFormFieldFromFieldTree()

protected FormFields::_removeFormFieldFromFieldTree (

\setasign\SetaPDF2\Core\Type\IndirectObjectInterface $fieldObject

): void

Removes a form field in its parent fields array

Parameters

$fieldObject : \setasign\SetaPDF2\Core\Type\IndirectObjectInterface

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\Type\Exception

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

Throws \setasign\SetaPDF2\Exception

Throws \setasign\SetaPDF2\NotImplementedException

handle()

public FormFields::handle (

array $touchedPdfs,
array $documents

): void

Parameters

$touchedPdfs : array
$documents : array

Exceptions

Throws \setasign\SetaPDF2\Core\Document\ObjectNotFoundException

Throws \setasign\SetaPDF2\Merger\Exception

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Exception

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

Throws \setasign\SetaPDF2\Core\Reader\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

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

Throws \setasign\SetaPDF2\Exception

Throws \setasign\SetaPDF2\NotImplementedException

setRenameSameNamedFormFields()

public FormFields::setRenameSameNamedFormFields (

bool $renameSameNamedFormFields = true

): void

Set the flag defining if same named form fields should be renamed (default behavior).

If this flag is set to false the fields will be merged so that all same named fields will have the same value. Notice that this could occur in an incorrect appearance if the initial values are different.

Parameters

$renameSameNamedFormFields : bool: The flag status