SetaPDF_Signer_SignatureField Helper class to create/handle a signature field

File: /SetaPDF v2/Signer/SignatureField.php

Class hierarchy

Summary

Constants

DEFAULT_FIELD_NAME

public const string SetaPDF_Signer_SignatureField::DEFAULT_FIELD_NAME = 'Signature'

The default signature field name

LOCK_DOCUMENT_ALL

LOCK_DOCUMENT_EXCLUDE

LOCK_DOCUMENT_INCLUDE

LOCK_DOCUMENT_NONE

POSITION_CENTER_BOTTOM

Position constant

POSITION_CENTER_MIDDLE

Position constant

POSITION_CENTER_TOP

Position constant

POSITION_LEFT_BOTTOM

Position constant

POSITION_LEFT_MIDDLE

Position constant

POSITION_LEFT_TOP

Position constant

POSITION_RIGHT_BOTTOM

Position constant

POSITION_RIGHT_MIDDLE

Position constant

POSITION_RIGHT_TOP

Position constant

TYPE_3D

Annotation type

TYPE_CARET

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_CARET = 'Caret'

Annotation type

TYPE_CIRCLE

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_CIRCLE = 'Circle'

Annotation type

TYPE_FILE_ATTACHMENT

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_FILE_ATTACHMENT = 'FileAttachment'

Annotation type

TYPE_FREE_TEXT

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_FREE_TEXT = 'FreeText'

Annotation type

TYPE_HIGHLIGHT

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_HIGHLIGHT = 'Highlight'

Annotation type

TYPE_INK

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_INK = 'Ink'

Annotation type

TYPE_LINE

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_LINE = 'Line'

Annotation type

TYPE_LINK

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_LINK = 'Link'

Annotation type

TYPE_MOVIE

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_MOVIE = 'Movie'

Annotation type

TYPE_POLYGON

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_POLYGON = 'Polygon'

Annotation type

TYPE_POLY_LINE

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_POLY_LINE = 'PolyLine'

Annotation type

TYPE_POPUP

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_POPUP = 'Popup'

Annotation type

TYPE_PRINTER_MARK

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_PRINTER_MARK = 'PrinterMark'

Annotation type

TYPE_REDACT

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_REDACT = 'Redact'

Annotation type

TYPE_SCREEN

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_SCREEN = 'Screen'

Annotation type

TYPE_SOUND

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_SOUND = 'Sound'

Annotation type

TYPE_SQUARE

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_SQUARE = 'Square'

Annotation type

TYPE_SQUIGGLY

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_SQUIGGLY = 'Squiggly'

Annotation type

TYPE_STAMP

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_STAMP = 'Stamp'

Annotation type

TYPE_STRIKE_OUT

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_STRIKE_OUT = 'StrikeOut'

Annotation type

TYPE_TEXT

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_TEXT = 'Text'

Annotation type

TYPE_TRAP_NET

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_TRAP_NET = 'TrapNet'

Annotation type

TYPE_UNDERLINE

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_UNDERLINE = 'Underline'

Annotation type

TYPE_WATERMARK

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_WATERMARK = 'Watermark'

Annotation type

TYPE_WIDGET

public const string SetaPDF_Core_Document_Page_Annotation::TYPE_WIDGET = 'Widget'

Annotation type


Properties

$_annotationDictionary


Static Methods

_createAnnotationDictionary()

Creates an annotation dictionary with default values.

Parameters
$rect : SetaPDF_Core_DataStructure_Rectangle|array
 
$subtype : string
 

_removeDocMDP()

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

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

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 ]]]]]]
): SetaPDF_Signer_SignatureField

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

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Type_IndirectReference_Exception

byObjectOrDictionary()

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
 
Exceptions

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

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, ) ]
): SetaPDF_Core_Type_Dictionary

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

Throws InvalidArgumentException

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_Exception

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

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_Exception

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Type_IndirectReference_Exception

Throws SetaPDF_Signer_Exception


Methods

__construct()

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

Throws InvalidArgumentException

Throws SetaPDF_Core_Type_Exception

See

cleanUp()

Release memory/cycled references.

getAction()

Get the action of the annotation.

If no action is defined false will be returned.

Exceptions

Throws SetaPDF_Core_Type_Exception

getAdditionalActions()

Gets the additional actions object instance for this annotation.

getAnnotationDictionary()

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

Throws InvalidArgumentException

getAppearanceCharacteristics()

Get the appearance characteristics object.

Parameters
$create : bool
 
Exceptions

Throws SetaPDF_Core_Type_Exception

getColor()

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()

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

Throws SetaPDF_Core_Type_Exception

getHiddenFlag()

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()

Get the indirect object of this annotation.

Parameters
$document : SetaPDF_Core_Document
 

getInvisibleFlag()

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

Throws SetaPDF_Core_Type_Exception

getLockedContents()

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()

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()

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()

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()

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()

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()

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()

Returns the qualified name.

Exceptions

Throws SetaPDF_Core_Type_Exception

getReadOnlyFlag()

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()

Get the rectangle object of this annotation.

getToggleNoView()

Checks for the "ToggleNoView" flag.

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

getType()

Get the annotation type specified in the Subtype entry.

getValue()

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

Throws SetaPDF_Core_Type_Exception

isAnnotationFlagSet()

Checks if a specific annotation flag is set.

Parameters
$flag : integer
 

setAction()

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

Throws InvalidArgumentException

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 (
null|bool|int|float|string|array|SetaPDF_Core_DataStructure_Color $color
): 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

setInvisibleFlag()

public SetaPDF_Core_Document_Page_Annotation::setInvisibleFlag (
[ boolean $invisible = true ]
): void

Set the "Invisible" flag.

Parameters
$invisible : boolean
 
See

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

Throws SetaPDF_Core_Type_Exception

setLocked()

public SetaPDF_Core_Document_Page_Annotation::setLocked (
[ boolean $locked = true ]
): void

Set the "Locked" flag.

Parameters
$locked : boolean
 
See

setLockedContents()

public SetaPDF_Core_Document_Page_Annotation::setLockedContents (
[ boolean $lockedContents = true ]
): void

Set the "LockedContents" flag.

Parameters
$lockedContents : boolean
 
See

setModificationDate()

Set the modification date.

Parameters
$date : SetaPDF_Core_DataStructure_Date|DateTime|string|bool

If true is passed, the current date and time will be used.

Exceptions

Throws Exception

setName()

public SetaPDF_Core_Document_Page_Annotation::setName (
string|null $name [, string $encoding = 'UTF-8' ]
): void

Set the name of the annotation.

The annotation name, a text string uniquely identifying it among all the annotations on its page.

Parameters
$name : string|null
 
$encoding : string
 

setNoRotateFlag()

public SetaPDF_Core_Document_Page_Annotation::setNoRotateFlag (
[ boolean $noRotate = true ]
): void

Set the "NoRotate" flag.

Parameters
$noRotate : boolean
 
See

setNoViewFlag()

public SetaPDF_Core_Document_Page_Annotation::setNoViewFlag (
[ boolean $noView = true ]
): void

Set the "NoView" flag.

Parameters
$noView : boolean
 
See

setNoZoomFlag()

public SetaPDF_Core_Document_Page_Annotation::setNoZoomFlag (
[ boolean $noZoom = true ]
): void

Set the "NoZoom" flag.

Parameters
$noZoom : boolean
 
See

setPrintFlag()

public SetaPDF_Core_Document_Page_Annotation::setPrintFlag (
[ boolean $print = true ]
): void

Set the "Print" flag.

Parameters
$print : boolean
 
See

setReadOnlyFlag()

public SetaPDF_Core_Document_Page_Annotation::setReadOnlyFlag (
[ boolean $readOnly = true ]
): void

Set the "ReadOnly" flag.

Parameters
$readOnly : boolean
 
See

setRect()

setToggleNoView()

public SetaPDF_Core_Document_Page_Annotation::setToggleNoView (
[ boolean $toggleNoView = true ]
): void

Set the "ToggleNoView" flag.

Parameters
$toggleNoView : boolean
 
See

unsetAnnotationFlags()

Removes a field flag.

Parameters
$flags : integer