Class SetaPDF_Signer_Signature_Appearance_Dynamic in SetaPDF v2 API Reference

Index

\SetaPDF
1. Signer
2. Signer
  1. Signature
    1. Appearance

SetaPDF_Signer_Signature_Appearance_Dynamic Class representing a dynamic visible signature appearance

File: /SetaPDF v2/Signer/Signature/Appearance/Dynamic.php

This signature appearance allows you to define a background image or xobject and a logo. The appearance will also display certificate details extracted from the used certificate and some signature properties like location.

Class hierarchy

SetaPDF_Signer_Signature_Appearance_AbstractAppearance
- SetaPDF_Signer_Signature_Appearance_Dynamic

Summary

Constants

CONFIG_BACKGROUND_LOGO

public const SetaPDF_Signer_Signature_Appearance_Dynamic::CONFIG_BACKGROUND_LOGO = 'backgroundLogo'

CONFIG_BACKGROUND_LOGO_OPACITY

public const SetaPDF_Signer_Signature_Appearance_Dynamic::CONFIG_BACKGROUND_LOGO_OPACITY = 'backgroundLogoOpacity'

CONFIG_DATE

public const SetaPDF_Signer_Signature_Appearance_Dynamic::CONFIG_DATE = 'date'

CONFIG_DISTINGUISHED_NAME

public const SetaPDF_Signer_Signature_Appearance_Dynamic::CONFIG_DISTINGUISHED_NAME = 'distinguishedName'

CONFIG_GRAPHIC

public const SetaPDF_Signer_Signature_Appearance_Dynamic::CONFIG_GRAPHIC = 'graphic'

CONFIG_GRAPHIC_ALIGN

public const SetaPDF_Signer_Signature_Appearance_Dynamic::CONFIG_GRAPHIC_ALIGN = 'graphicAlign'

CONFIG_GRAPHIC_ALIGN_LEFT

public const SetaPDF_Signer_Signature_Appearance_Dynamic::CONFIG_GRAPHIC_ALIGN_LEFT = 'left'

CONFIG_GRAPHIC_ALIGN_RIGHT

public const SetaPDF_Signer_Signature_Appearance_Dynamic::CONFIG_GRAPHIC_ALIGN_RIGHT = 'right'

CONFIG_GRAPHIC_COLOR

public const SetaPDF_Signer_Signature_Appearance_Dynamic::CONFIG_GRAPHIC_COLOR = 'graphicColor'

CONFIG_LABELS

public const SetaPDF_Signer_Signature_Appearance_Dynamic::CONFIG_LABELS = 'labels'

CONFIG_LOCATION

public const SetaPDF_Signer_Signature_Appearance_Dynamic::CONFIG_LOCATION = 'location'

CONFIG_NAME

public const SetaPDF_Signer_Signature_Appearance_Dynamic::CONFIG_NAME = 'name'

CONFIG_REASON

public const SetaPDF_Signer_Signature_Appearance_Dynamic::CONFIG_REASON = 'reason'

CONFIG_SHOW_DATE

public const SetaPDF_Signer_Signature_Appearance_Dynamic::CONFIG_SHOW_DATE = 'showDate'

CONFIG_SHOW_DATE_FORMAT

public const SetaPDF_Signer_Signature_Appearance_Dynamic::CONFIG_SHOW_DATE_FORMAT = 'showDateFormat'

CONFIG_SHOW_DATE_TPL

public const SetaPDF_Signer_Signature_Appearance_Dynamic::CONFIG_SHOW_DATE_TPL = 'showDateTpl'

CONFIG_SHOW_DISTINGUISHED_NAME

public const SetaPDF_Signer_Signature_Appearance_Dynamic::CONFIG_SHOW_DISTINGUISHED_NAME = 'showDistinguishedName'

CONFIG_SHOW_DISTINGUISHED_NAME_TPL

public const SetaPDF_Signer_Signature_Appearance_Dynamic::CONFIG_SHOW_DISTINGUISHED_NAME_TPL = 'showDistinguishedNameTpl'

CONFIG_SHOW_LABELS

public const SetaPDF_Signer_Signature_Appearance_Dynamic::CONFIG_SHOW_LABELS = 'showLabels'

CONFIG_SHOW_LOCATION

public const SetaPDF_Signer_Signature_Appearance_Dynamic::CONFIG_SHOW_LOCATION = 'showLocation'

CONFIG_SHOW_LOCATION_TPL

public const SetaPDF_Signer_Signature_Appearance_Dynamic::CONFIG_SHOW_LOCATION_TPL = 'showLocationTpl'

CONFIG_SHOW_NAME

public const SetaPDF_Signer_Signature_Appearance_Dynamic::CONFIG_SHOW_NAME = 'showName'

CONFIG_SHOW_NAME_TPL

public const SetaPDF_Signer_Signature_Appearance_Dynamic::CONFIG_SHOW_NAME_TPL = 'showNameTpl'

CONFIG_SHOW_REASON

public const SetaPDF_Signer_Signature_Appearance_Dynamic::CONFIG_SHOW_REASON = 'showReason'

CONFIG_SHOW_REASON_TPL

public const SetaPDF_Signer_Signature_Appearance_Dynamic::CONFIG_SHOW_REASON_TPL = 'showReasonTpl'

CONFIG_TEXT_ALIGN

public const SetaPDF_Signer_Signature_Appearance_Dynamic::CONFIG_TEXT_ALIGN = 'textAlign'

CONFIG_TEXT_COLOR

public const SetaPDF_Signer_Signature_Appearance_Dynamic::CONFIG_TEXT_COLOR = 'textColor'

Properties

$_certificate

protected SetaPDF_Signer_X509_Certificate SetaPDF_Signer_Signature_Appearance_Dynamic::$_certificate

The certificate

$_certificateInfo

protected null|array SetaPDF_Signer_Signature_Appearance_Dynamic::$_certificateInfo

The certificate info returned from openssl_x509_parse()

$_config

protected array SetaPDF_Signer_Signature_Appearance_Dynamic::$_config = array(...)

The configuration array

$_font

protected SetaPDF_Core_Font_FontInterface SetaPDF_Signer_Signature_Appearance_Dynamic::$_font

A font that is used for rendering text.

Methods

__construct()

public SetaPDF_Signer_Signature_Appearance_Dynamic::__construct (

SetaPDF_Signer_Signature_Module_ModuleInterface|SetaPDF_Signer_X509_Certificate|string $moduleOrCertificate

)

The constructor.

Just pass a signature module that offers a getCertificate() method or a certificate argument to the constructor. The data for the appearance will be extracted automatically.

Parameters

$moduleOrCertificate : SetaPDF_Signer_Signature_Module_ModuleInterface|SetaPDF_Signer_X509_Certificate|string

Exceptions

Throws InvalidArgumentException

Throws SetaPDF_Signer_Asn1_Exception

_drawBackground()

protected SetaPDF_Signer_Signature_Appearance_Dynamic::_drawBackground (

SetaPDF_Core_XObject_Form $xObject, SetaPDF_Core_Document $document

): void

Draw the background logo of the signature appearance.

Parameters

$xObject : SetaPDF_Core_XObject_Form
$document : SetaPDF_Core_Document

_drawGraphic()

protected SetaPDF_Signer_Signature_Appearance_Dynamic::_drawGraphic (

SetaPDF_Core_XObject_Form $xObject, SetaPDF_Core_Document $document, SetaPDF_Signer $signer

): void

Draws the graphic on the left or right side of the signature appearance.

Parameters

$xObject : SetaPDF_Core_XObject_Form
$document : SetaPDF_Core_Document
$signer : SetaPDF_Signer

Exceptions

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Signer_Exception

_drawText()

protected SetaPDF_Signer_Signature_Appearance_Dynamic::_drawText (

string $text, SetaPDF_Core_XObject_Form $xObject, SetaPDF_Core_Document $document

): void

Draws the text on the appearance.

If no graphic is set the text will be placed on the full width of the appearance.

Parameters

$text : string
$xObject : SetaPDF_Core_XObject_Form
$document : SetaPDF_Core_Document

Exceptions

Throws SetaPDF_Core_Type_Exception

_getN2XObject()

protected SetaPDF_Signer_Signature_Appearance_Dynamic::_getN2XObject (

SetaPDF_Signer_SignatureField $field, SetaPDF_Core_Document $document, SetaPDF_Signer $signer

): SetaPDF_Core_XObject_Form

Creates the "n2" layer appearance.

Parameters

$field : SetaPDF_Signer_SignatureField
$document : SetaPDF_Core_Document
$signer : SetaPDF_Signer

Exceptions

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Signer_Exception

_prepareText()

protected SetaPDF_Signer_Signature_Appearance_Dynamic::_prepareText (

SetaPDF_Signer $signer

): string

Prepares the text string.

Parameters

$signer : SetaPDF_Signer

Exceptions

Throws SetaPDF_Signer_Exception

Throws Exception

cleanUp()

public SetaPDF_Signer_Signature_Appearance_Dynamic::cleanUp (

void

): void

Release memory/cycled references.

createAppearance()

public SetaPDF_Signer_Signature_Appearance_AbstractAppearance::createAppearance (

SetaPDF_Signer_SignatureField $field, SetaPDF_Core_Document $document, SetaPDF_Signer $signer

): void

Creates the XObject structure and "layers" (n0 + n2).

Parameters

$field : SetaPDF_Signer_SignatureField
$document : SetaPDF_Core_Document
$signer : SetaPDF_Signer

getBackgroundLogo()

public SetaPDF_Signer_Signature_Appearance_Dynamic::getBackgroundLogo (

void

): mixed

Get the current background logo.

getBackgroundLogoOpacity()

public SetaPDF_Signer_Signature_Appearance_Dynamic::getBackgroundLogoOpacity (

void

): float

Get the background logo opacity.

getCertificateInfo()

public SetaPDF_Signer_Signature_Appearance_Dynamic::getCertificateInfo (

void

): array|null

Returns information about the supplied certificate.

Exceptions

Throws SetaPDF_Signer_Exception

getConfig()

public SetaPDF_Signer_Signature_Appearance_Dynamic::getConfig (

string $key

): bool|mixed

Get a specific configuration value.

Parameters

$key : string: The key of the config. See and use SetaPDF_Signer_Signature_Appearance_Dynamic::CONFIG_XXX for a valid key.

Return Values

Returns false if the key is invalid.

getFont()

public SetaPDF_Signer_Signature_Appearance_Dynamic::getFont (

void

): SetaPDF_Core_Font_FontInterface|null

Get the font that should be used for displaying text.

getGraphic()

public SetaPDF_Signer_Signature_Appearance_Dynamic::getGraphic (

void

): mixed

Get if and how the graphic on is displayed.

getGraphicAlign()

public SetaPDF_Signer_Signature_Appearance_Dynamic::getGraphicAlign (

void

): string

Get whether the graphic should be displayed on the left or right.

getGraphicColor()

public SetaPDF_Signer_Signature_Appearance_Dynamic::getGraphicColor (

void

): string

Get the graphic text color.

getShow()

public SetaPDF_Signer_Signature_Appearance_Dynamic::getShow (

string $name

): boolean

Get whether a text part will be shown or not.

Parameters

$name : string

See

SetaPDF_Signer_Signature_Appearance_Dynamic::setShow()

getShowFormat()

public SetaPDF_Signer_Signature_Appearance_Dynamic::getShowFormat (

string $name

): bool|mixed

Get the format for a specific value.

Parameters

$name : string

See

SetaPDF_Signer_Signature_Appearance_Dynamic::setShowFormat()

getShowTpl()

public SetaPDF_Signer_Signature_Appearance_Dynamic::getShowTpl (

string $name

): string

Get a defined template for a specific text part.

Parameters

$name : string

See

SetaPDF_Signer_Signature_Appearance_Dynamic::setShowTpl()

getTextAlign()

public SetaPDF_Signer_Signature_Appearance_Dynamic::getTextAlign (

void

): string

Get the text align.

getTextColor()

public SetaPDF_Signer_Signature_Appearance_Dynamic::getTextColor (

void

): string

Get the text color.

setBackgroundLogo()

public SetaPDF_Signer_Signature_Appearance_Dynamic::setBackgroundLogo (

[ SetaPDF_Core_XObject $xObject = null [, float $opacity = 1.0 ]]

): SetaPDF_Signer_Signature_Appearance_Dynamic

Set a background logo and its opacity.

The background logo is displayed in the center of the appearance.

Parameters

$xObject : SetaPDF_Core_XObject
$opacity : float

setBackgroundLogoOpacity()

public SetaPDF_Signer_Signature_Appearance_Dynamic::setBackgroundLogoOpacity (

float $opacity

): $this

Set the background logo opacity.

Parameters

$opacity : float: A value between 0 (not visible) an 1 (full opacity)

setConfig()

public SetaPDF_Signer_Signature_Appearance_Dynamic::setConfig (

string $key, mixed $value

): boolean|SetaPDF_Signer_Signature_Appearance_Dynamic

Set a specific configuration value.

Parameters

$key : string: The key of the config. See and use SetaPDF_Signer_Signature_Appearance_Dynamic::CONFIG_XXX for a valid key.
$value : mixed

Return Values

Returns false if the key is invalid.

setFont()

public SetaPDF_Signer_Signature_Appearance_Dynamic::setFont (

[ SetaPDF_Core_Font_FontInterface|null $font = null ]

): void

Set the font that should be used for displaying text.

Parameters

$font : SetaPDF_Core_Font_FontInterface|null

setGraphic()

public SetaPDF_Signer_Signature_Appearance_Dynamic::setGraphic (

SetaPDF_Core_XObject|boolean $graphic

): $this

Set how and if a graphic is displayed on the appearance.

If a XObject is passed it will be used as the graphic, if true is passed the common name of the certificate will be used. If false is passed no graphic will be shown.

Parameters

$graphic : SetaPDF_Core_XObject|boolean: A XObject or a boolean value

setGraphicAlign()

public SetaPDF_Signer_Signature_Appearance_Dynamic::setGraphicAlign (

string $align

): void

Set whether the graphic should be displayed on the left or right.

Parameters

$align : string: A self::CONFIG_GRAPHIC_ALIGN_* constant.

See

self::CONFIG_GRAPHIC_ALIGN_RIGHT
self::CONFIG_GRAPHIC_ALIGN_LEFT

setGraphicColor()

public SetaPDF_Signer_Signature_Appearance_Dynamic::setGraphicColor (

string $graphicColor

): $this

Set the graphic text color.

Parameters

$graphicColor : string

setShow()

public SetaPDF_Signer_Signature_Appearance_Dynamic::setShow (

string $name [, boolean $show = true ]

): $this|bool

Defines whether a text part will be shown or not.

Available names are:

Parameters

$name : string
$show : boolean

setShowFormat()

public SetaPDF_Signer_Signature_Appearance_Dynamic::setShowFormat (

string $name, string $format

): $this|bool

Sets a format for a specific value.

Currently only the $name SetaPDF_Signer_Signature_Appearance_Dynamic::CONFIG_DATE is supported.

Parameters

$name : string
$format : string

setShowTpl()

public SetaPDF_Signer_Signature_Appearance_Dynamic::setShowTpl (

string $name, string $tpl

): $this|bool

Defines a template for a specific text.

The template will be used as a label of a specific value. The value is passed via sprintf() to this template.

Following names are possible:

Parameters

$name : string
$tpl : string

setTextAlign()

public SetaPDF_Signer_Signature_Appearance_Dynamic::setTextAlign (

string $textAlign

): $this

Set the text align.

Parameters

$textAlign : string

See

SetaPDF_Core_Text

setTextColor()

public SetaPDF_Signer_Signature_Appearance_Dynamic::setTextColor (

string $textColor

): $this

Set the text color.

Parameters

$textColor : string