SetaPDF v2 API Reference

Creates an annotation dictionary with default values.

Parameters

$rect : SetaPDF_Core_DataStructure_Rectangle|array
$subtype : string

_removeDocMDP()

protected static SetaPDF_Signer_SignatureField::_removeDocMDP (

SetaPDF_Core_Document $document, SetaPDF_Signer_SignatureField $field

): boolean

Remove the DocMDP entry from the Perms dictionary if it is the value of the given signature field.

Parameters

$document : SetaPDF_Core_Document
$field : SetaPDF_Signer_SignatureField

Return Values

Wether the field value was used in the DocMDP entry or not.

Exceptions

): SetaPDF_Signer_SignatureField

add()

public static SetaPDF_Signer_SignatureField::add (

SetaPDF_Core_Document $document [, string $fieldName = SetaPDF_Signer_SignatureField ::DEFAULT_FIELD_NAME [, int $pageNumber = 1 [, int|string $xOrPosition = 0 [, int|array $yOrTranslate = 0 [, int $width = 0 [, int $height = 0 ]]]]]]

Adds a new signature field to a documents page.

It is possible to position the field relatively to the page boundary by passing a string value to the $xOrPosition parameter.

Additionally it is possible to define own x- and y-values through the desired parameter. Anyhow this will not take care of page rotation.

Parameters

$document : SetaPDF_Core_Document
$fieldName : string: The field name in UTF-8 encoding
$pageNumber : int: The page number on which the signature field shall appear.
$xOrPosition : int|string: Integer with the x-position or SetaPDF_Signer_SignatureField::POSITION_XXX
$yOrTranslate : int|array: Integer with the y-position (if $xOrPosition is an integer) or an array with the keys 'x' and 'y'
$width : int: Width of the signature field
$height : int: Height of the signature field

Exceptions

): SetaPDF_Core_Document_Page_Annotation

Throws SetaPDF_Core_Type_IndirectReference_Exception

byObjectOrDictionary()

public static SetaPDF_Core_Document_Page_Annotation::byObjectOrDictionary (

SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Type_IndirectObjectInterface $objectOrDictionary

Creates an annotation object by an annotation dictionary or its parent object.

Parameters

$objectOrDictionary : SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Type_IndirectObjectInterface

Exceptions

clear()

public static SetaPDF_Signer_SignatureField::clear (

SetaPDF_Core_Document $document, string $fieldName [, bool $clearAppearance = true ]

): bool

Clears the signature from a signature field by its name.

Parameters

$document : SetaPDF_Core_Document
$fieldName : string
$clearAppearance : bool: Define whether the appearance is cleared or not, too.

Exceptions

Throws SetaPDF_Core_Type_IndirectReference_Exception

Throws SetaPDF_Signer_Exception

createAnnotationDictionary()

public static SetaPDF_Signer_SignatureField::createAnnotationDictionary (

string $fieldName [, array|SetaPDF_Core_DataStructure_Rectangle $rect = array ( 0 => 0, 1 => 0, 2 => 0, 3 => 0, ) ]

Function to create a signature field annotation dictionary.

Parameters

$fieldName : string: The field name in UTF-8 encoding.
$rect : array|SetaPDF_Core_DataStructure_Rectangle

Exceptions

delete()

public static SetaPDF_Signer_SignatureField::delete (

SetaPDF_Core_Document $document, string $fieldName

): bool

Deletes a signature field by its name.

ATTENTION: If there are other signature fields in use their signature will get invalid.

Parameters

$document : SetaPDF_Core_Document
$fieldName : string

Exceptions

Throws SetaPDF_Core_Type_IndirectReference_Exception

Throws SetaPDF_Signer_Exception

get()

public static SetaPDF_Signer_SignatureField::get (

SetaPDF_Core_Document $document [, string $fieldName = SetaPDF_Signer_SignatureField ::DEFAULT_FIELD_NAME [, bool $create = true ]]

): bool|SetaPDF_Signer_SignatureField

Get a signature field instance and creates it if it is not already available.

If no field is found a hidden field on page one will be created automatically.

Parameters

$document : SetaPDF_Core_Document
$fieldName : string: The field name in UTF-8 encoding
$create : bool: Automatically creates a hidden field if none was found by the specified name

Exceptions

Throws SetaPDF_Core_Type_IndirectReference_Exception

Throws SetaPDF_Signer_Exception

Methods

__construct()

public SetaPDF_Signer_SignatureField::__construct (

string|array|SetaPDF_Core_Type_AbstractType|SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Type_IndirectObjectInterface $objectOrDictionary

)

The constructor.

An instance could be created by an existing dictionary, indirect object/reference or by the same parameters as createAnnotationDictionary().

Parameters

$objectOrDictionary : string|array|SetaPDF_Core_Type_AbstractType|SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Type_IndirectObjectInterface

Exceptions

See

SetaPDF_Signer_SignatureField::createAnnotationDictionary()

cleanUp()

public SetaPDF_Core_Document_Page_Annotation_Widget::cleanUp (

void

): void

Release memory/cycled references.

getAction()

public SetaPDF_Core_Document_Page_Annotation_Widget::getAction (

void

): bool|SetaPDF_Core_Document_Action

Get the action of the annotation.

If no action is defined false will be returned.

Exceptions

): SetaPDF_Core_Document_Page_Annotation_Widget_AdditionalActions

getAdditionalActions()

public SetaPDF_Core_Document_Page_Annotation_Widget::getAdditionalActions (

void

Gets the additional actions object instance for this annotation.

getAnnotationDictionary()

WARNING: This method is marked as deprecated!

public SetaPDF_Core_Document_Page_Annotation::getAnnotationDictionary (

void

Get the annotation dictionary.

getAppearance()

public SetaPDF_Core_Document_Page_Annotation::getAppearance (

[ string $type = 'N' [, null|string $subName = null ]]

): null|SetaPDF_Core_XObject_Form

Get the annotation appearance stream.

Parameters

$type : string
$subName : null|string

Exceptions

getAppearanceCharacteristics()

public SetaPDF_Core_Document_Page_Annotation_Widget::getAppearanceCharacteristics (

[ bool $create = false ]

): null|SetaPDF_Core_Document_Page_Annotation_AppearanceCharacteristics

Get the appearance characteristics object.

Parameters

$create : bool

Exceptions

): SetaPDF_Core_Document_Page_Annotation_BorderStyle

getBorderStyle()

public SetaPDF_Core_Document_Page_Annotation_Widget::getBorderStyle (

void

Get the border style object.

getColor()

public SetaPDF_Core_Document_Page_Annotation::getColor (

void

): null|SetaPDF_Core_DataStructure_Color

Get the color of the annotation.

getContents()

public SetaPDF_Core_Document_Page_Annotation::getContents (

[ string $encoding = 'UTF-8' ]

): null|string

Get the contents of the annotation.

Parameters

$encoding : string

getDictionary()

public SetaPDF_Core_Document_Page_Annotation::getDictionary (

void

Get the annotation dictionary.

getHeight()

public SetaPDF_Core_Document_Page_Annotation_Widget::getHeight (

[ boolean $ignoreRotation = false ]

): float|int

Get the height of the annotation.

If the annotation is rotated width and height will be changed accordingly. This can be affected by the $ignoreRotation parameter.

Parameters

$ignoreRotation : boolean

Exceptions

): SetaPDF_Core_Type_IndirectObjectInterface

getHiddenFlag()

public SetaPDF_Core_Document_Page_Annotation::getHiddenFlag (

void

): boolean

Checks for the "Hidden" flag.

PDF 32000-1:2008 - Table 165: "If set, do not display or print the annotation or allow it to interact with the user, regardless of its annotation type or whether an annotation handler is available."

getIndirectObject()

public SetaPDF_Core_Document_Page_Annotation::getIndirectObject (

[ SetaPDF_Core_Document $document = null ]

Get the indirect object of this annotation.

Parameters

$document : SetaPDF_Core_Document

getInvisibleFlag()

public SetaPDF_Core_Document_Page_Annotation::getInvisibleFlag (

void

): boolean

Checks for the "Invisible" flag.

PDF 32000-1:2008 - Table 165: "If set, do not display the annotation if it does not belong to one of the standard annotation types and no annotation handler is available. If clear, display such an unknown annotation using an appearance stream specified by its appearance dictionary, if any"

getLock()

public SetaPDF_Signer_SignatureField::getLock (

void

): array|bool

Get information about lock data if available.

Exceptions

getLockedContents()

public SetaPDF_Core_Document_Page_Annotation::getLockedContents (

void

): boolean

Checks for the "LockedContents" flag.

PDF 32000-1:2008 - Table 165: "If set, do not allow the contents of the annotation to be modified by the user. This flag does not restrict deletion of the annotation or changes to other annotation properties, such as position and size."

getLockedFlag()

public SetaPDF_Core_Document_Page_Annotation::getLockedFlag (

void

): boolean

Checks the "Locked" flag.

PDF 32000-1:2008 - Table 165: "If set, do not allow the annotation to be deleted or its properties (including position and size) to be modified by the user. However, this flag does not restrict changes to the annotation’s contents, such as the value of a form field."

getModificationDate()

public SetaPDF_Core_Document_Page_Annotation::getModificationDate (

[ bool $asString = true ]

): mixed|null|SetaPDF_Core_DataStructure_Date

Get the modification date.

Parameters

$asString : bool

Exceptions

Throws Exception

getName()

public SetaPDF_Core_Document_Page_Annotation::getName (

[ string $encoding = 'UTF-8' ]

): string|null

Get the name of the annotation.

Parameters

$encoding : string

getNoRotateFlag()

public SetaPDF_Core_Document_Page_Annotation::getNoRotateFlag (

void

): boolean

Checks fo the "NoRotate" flag.

PDF 32000-1:2008 - Table 165: "If set, do not rotate the annotation’s appearance to match the rotation of the page. The upper-left corner of the annotation rectangle shall remain in a fixed location on the page, regardless of the page rotation."

getNoViewFlag()

public SetaPDF_Core_Document_Page_Annotation::getNoViewFlag (

void

): boolean

Checks for the "NoView" flag.

PDF 32000-1:2008 - Table 165: "If set, do not display the annotation on the screen or allow it to interact with the user. The annotation may be printed (depending on the setting of the Print flag) but should be considered hidden for purposes of on-screen display and user interaction."

getNoZoomFlag()

public SetaPDF_Core_Document_Page_Annotation::getNoZoomFlag (

void

): boolean

Checks fo the "NoZoom" flag.

PDF 32000-1:2008 - Table 165: "If set, do not scale the annotation’s appearance to match the magnification of the page. The location of the annotation on the page (defined by the upper- left corner of its annotation rectangle) shall remain fixed, regardless of the page magnification."

getPrintFlag()

public SetaPDF_Core_Document_Page_Annotation::getPrintFlag (

void

): boolean

Checks for the "Print" flag.

PDF 32000-1:2008 - Table 165: "If set, print the annotation when the page is printed. If clear, never print the annotation, regardless of whether it is displayed on the screen."

getQualifiedName()

public SetaPDF_Signer_SignatureField::getQualifiedName (

void

): string

Returns the qualified name.

Exceptions

): SetaPDF_Core_DataStructure_Rectangle

getReadOnlyFlag()

public SetaPDF_Core_Document_Page_Annotation::getReadOnlyFlag (

void

): boolean

Checks the "ReadOnly" flag.

PDF 32000-1:2008 - Table 165: "If set, do not allow the annotation to interact with the user. The annotation may be displayed or printed (depending on the settings of the NoView and Print flags) but should not respond to mouse clicks or change its appearance in response to mouse motions.

This flag shall be ignored for widget annotations; its function is subsumed by the ReadOnly flag of the associated form field"

getRect()

public SetaPDF_Core_Document_Page_Annotation::getRect (

void

Get the rectangle object of this annotation.

getToggleNoView()

public SetaPDF_Core_Document_Page_Annotation::getToggleNoView (

void

): boolean

Checks for the "ToggleNoView" flag.

PDF 32000-1:2008 - Table 165: "If set, invert the interpretation of the NoView flag for certain events."

getType()

public SetaPDF_Core_Document_Page_Annotation::getType (

void

): string

Get the annotation type specified in the Subtype entry.

getValue()

public SetaPDF_Signer_SignatureField::getValue (

void

): null|SetaPDF_Core_Type_Dictionary

Get the signature value dictionary of this field, if present.

getWidth()

public SetaPDF_Core_Document_Page_Annotation_Widget::getWidth (

[ boolean $ignoreRotation = false ]

): float|int

Get the width of the annotation.

If the annotation is rotated width and height will be changed accordingly. This can be affected by the $ignoreRotation parameter.

Parameters

$ignoreRotation : boolean

Exceptions

isAnnotationFlagSet()

public SetaPDF_Core_Document_Page_Annotation::isAnnotationFlagSet (

integer $flag

): boolean

Checks if a specific annotation flag is set.

Parameters

$flag : integer

setAction()

public SetaPDF_Core_Document_Page_Annotation_Widget::setAction (

SetaPDF_Core_Document_Action|SetaPDF_Core_Type_Dictionary $action

): void

Set the action of the annotation.

The action could be an instance of SetaPDF_Core_Document_Action or a plain dictionary representing the action.

Parameters

$action : SetaPDF_Core_Document_Action|SetaPDF_Core_Type_Dictionary

Exceptions

setAnnotationFlags()

public SetaPDF_Core_Document_Page_Annotation::setAnnotationFlags (

integer $flags [, boolean $set = true ]

): void

Sets an annotation flag.

Parameters

$flags : integer
$set : boolean: Set or unset

setAppearance()

public SetaPDF_Core_Document_Page_Annotation::setAppearance (

SetaPDF_Core_XObject_Form $xObject [, string $type = 'N' [, string|null $subState = null ]]

): void

Set the annotation appearance stream.

Parameters

$xObject : SetaPDF_Core_XObject_Form
$type : string
$subState : string|null

setColor()

public SetaPDF_Core_Document_Page_Annotation::setColor (

): void

Set the color of the annotation.

Parameters

$color : null|bool|int|float|string|array|SetaPDF_Core_DataStructure_Color

setContents()

public SetaPDF_Core_Document_Page_Annotation::setContents (

string|null $contents [, string $encoding = 'UTF-8' ]

): void

Set the contents of the annotation.

Parameters

$contents : string|null
$encoding : string

setHiddenFlag()

public SetaPDF_Core_Document_Page_Annotation::setHiddenFlag (

[ boolean $hidden = true ]

): void

Set the "Hidden" flag.

Parameters

$hidden : boolean

See

SetaPDF_Core_Document_Page_Annotation::getHiddenFlag()

setInvisibleFlag()

public SetaPDF_Core_Document_Page_Annotation::setInvisibleFlag (

[ boolean $invisible = true ]

): void

Set the "Invisible" flag.

Parameters

$invisible : boolean

See

SetaPDF_Core_Document_Page_Annotation::getInvisibleFlag()

setLock()

public SetaPDF_Signer_SignatureField::setLock (

SetaPDF_Core_Document $document [, string|false $action = SetaPDF_Signer_SignatureField ::LOCK_DOCUMENT_ALL [, null|array $fields = null ]]

): void

Set if an how the document should be locked after a signature is applied to this field.

NOTICE: Currently only SetaPDF_Signer_SignatureField::LOCK_DOCUMENT_ALL or none is supported.

Parameters

$document : SetaPDF_Core_Document
$action : string|false: A name which indicates if all, none or indiviual fields should be locked or not locked.
$fields : null|array

Exceptions

Throws SetaPDF_Exception_NotImplemented