SetaPDF_Signer_SignatureField Helper class to create/handle a signature field

File: /SetaPDF/Signer/SignatureField.php

Class hierarchy

Summary

Constants

DEFAULT_FIELD_NAME

The default signature field name

LOCK_DOCUMENT_ALL

Lock value

See

LOCK_DOCUMENT_EXCLUDE

Lock value

See

LOCK_DOCUMENT_INCLUDE

Lock value

See

LOCK_DOCUMENT_NONE

Lock value

See

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


Properties

$_annotationDictionary


Static Methods

_createAnnotationDictionary()

Creates an annotation dictionary with default values.

Parameters
$rect : SetaPDF_Core_DataStructure_Rectangle|array
 
$subtype : string
 

add()

static public SetaPDF_Signer_SignatureField SetaPDF_Signer_SignatureField::add ( SetaPDF_Core_Document $document [, string $fieldName = self::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

Throws InvalidArgumentException

createAnnotationDictionary()

static public SetaPDF_Core_Type_Dictionary 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

Throws InvalidArgumentException

get()

static public bool|SetaPDF_Signer_SignatureField SetaPDF_Signer_SignatureField::get ( SetaPDF_Core_Document $document [, string $fieldName = self::DEFAULT_FIELD_NAME [, bool $create = true ]] )

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


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 : array|SetaPDF_Core_Type_AbstractType|SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Type_IndirectObjectInterface
 
Exceptions

Throws InvalidArgumentException

See

cleanUp()

Release memory/cycled references.

getAction()

Get the action of the annotation.

If no action is defined false will be returned.

getAdditionalActions()

Gets the additional actions object instance for this annotation.

getAnnotationDictionary()

getAppearance()

public null|SetaPDF_Core_XObject_Form SetaPDF_Core_Document_Page_Annotation::getAppearance ( [ string $type = 'N' [, null|string $subType = null ]] )

Get the annotation appearance stream.

Parameters
$type : string
 
$subType : null|string
 
Exceptions

Throws InvalidArgumentException

getAppearanceCharacteristics()

Get the appearance characteristics object.

Parameters
$create : bool
 

getColor()

Get the color of the annotation.

getContents()

public null|string SetaPDF_Core_Document_Page_Annotation::getContents ( [ string $encoding = 'UTF-8' ] )

Get the contents of the annotation.

Parameters
$encoding : string
 

getDictionary()

getHeight()

public float|int SetaPDF_Core_Document_Page_Annotation_Widget::getHeight ( [ boolean $ignoreRotation = false ] )

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
 

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 array|bool SetaPDF_Signer_SignatureField::getLock ( void )

Get information about lock data if available.

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
 

getName()

public mixed|null SetaPDF_Core_Document_Page_Annotation::getName ( [ string $encoding = 'UTF-8' ] )

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.

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 action type specified in the S key.

getValue()

Get the signature dictionary of this field, if present.

getWidth()

public float|int SetaPDF_Core_Document_Page_Annotation_Widget::getWidth ( [ boolean $ignoreRotation = false ] )

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
 

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 void SetaPDF_Core_Document_Page_Annotation::setAnnotationFlags ( integer $flags [, boolean $set = true ] )

Sets an annotation flag.

Parameters
$flags : integer
 
$set : boolean

Set or unset

setAppearance()

public void SetaPDF_Core_Document_Page_Annotation::setAppearance ( SetaPDF_Core_XObject_Form $xObject [, string $type = 'N' [, string|null $subState = null ]] )

Set the annotation appearance stream.

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

setColor()

public void SetaPDF_Core_Document_Page_Annotation::setColor ( null|bool|int|float|string|array|SetaPDF_Core_DataStructure_Color $color )

Set the color of the annotation.

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

setContents()

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

Set the contents of the annotation.

Parameters
$contents : string|null
 
$encoding : string
 

setHiddenFlag()

public void SetaPDF_Core_Document_Page_Annotation::setHiddenFlag ( [ boolean $hidden = true ] )

Set the "Hidden" flag.

Parameters
$hidden : boolean
 
See

setIndirectObject()

Set the indirect object of this annotation.

Parameters
$indirectReference : SetaPDF_Core_Type_IndirectObjectInterface
 

setInvisibleFlag()

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

Set the "Invisible" flag.

Parameters
$invisible : boolean
 
See

setLock()

public void SetaPDF_Signer_SignatureField::setLock ( SetaPDF_Core_Document $document [, string $action = self::LOCK_DOCUMENT_ALL [, null|array $fields = null ]] )

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

NOTICE: Currently only LOCK_DOCUMENT_ALL or none is supported.

Parameters
$document : SetaPDF_Core_Document
 
$action : string

A name which, in conjunction with Fields, indicates the set of $fields that should be locked.

$fields : null|array
 
Exceptions

Throws SetaPDF_Exception_NotImplemented

setLocked()

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

Set the "Locked" flag.

Parameters
$locked : boolean
 
See

setLockedContents()

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

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.

setName()

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

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 void SetaPDF_Core_Document_Page_Annotation::setNoRotateFlag ( [ boolean $noRotate = true ] )

Set the "NoRotate" flag.

Parameters
$noRotate : boolean
 
See

setNoViewFlag()

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

Set the "NoView" flag.

Parameters
$noView : boolean
 
See

setNoZoomFlag()

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

Set the "NoZoom" flag.

Parameters
$noZoom : boolean
 
See

setPrintFlag()

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

Set the "Print" flag.

Parameters
$print : boolean
 
See

setReadOnlyFlag()

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

Set the "ReadOnly" flag.

Parameters
$readOnly : boolean
 
See

setRect()

setToggleNoView()

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

Set the "ToggleNoView" flag.

Parameters
$toggleNoView : boolean
 
See

unsetAnnotationFlags()

Removes a field flag.

Parameters
$flags : integer