SetaPDF v2 API Reference

Index

\setasign\SetaPDF2
1. Signer
  1. Signature
    1. Appearance

setasign\SetaPDF2\Signer\Signature\Appearance

XObject Class representing a signature appearance based on an existing XObject

File: /SetaPDF v2/Signer/Signature/Appearance/XObject.php
Old class name (alias): \SetaPDF_Signer_Signature_Appearance_XObject

An XObject could be an image, an extracted page or a fresh unique instance of a Form XObject.

Class hierarchy

AbstractAppearance
- XObject

Summary

Methods

__construct()
_getN2XObject()
cleanUp()
createAppearance()

Properties

$_xObject

Properties

$_xObject

protected \SetaPDF_Core_XObject XObject::$_xObject

The XObject that should be placed into the appearance

Methods

__construct()

public XObject::__construct (

\SetaPDF_Core_XObject $xObject

)

The constructor.

Parameters

$xObject : \SetaPDF_Core_XObject

_getN2XObject()

protected XObject::_getN2XObject (

\SetaPDF_Signer_SignatureField $field,
\SetaPDF_Core_Document $document,
\SetaPDF_Signer $signer

): \SetaPDF_Core_XObject_Form

Get the n2-layer XObject.

Parameters

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

cleanUp()

public XObject::cleanUp (

void

): void

Release memory/cycled references.

createAppearance()

public 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