Facade

Fluent entry point for the signature subsystem, returned by Tcpdf::signature().

Table of contents

Namespace: Com\Tecnick\Pdf\Signature

final class Facade

Source: src/Signature/Facade.php:43

Fluent entry point for the signature subsystem, returned by Tcpdf::signature(). It groups the signature methods (configuration, timestamp, user rights, appearance, empty fields, external signing and the widget object id) behind one object, forwarding to the underlying Tcpdf methods.

Methods

__construct()

public __construct(Tcpdf $pdf)

Parameters:

Source: src/Signature/Facade.php:45

appearance()

Access the visible-appearance sub-facade.

public appearance(): Appearance

Returns: Appearance

Source: src/Signature/Facade.php:99

configure()

Configure the signature (certificate, key, profile, digest, LTV, info).

public configure(TSignature $data): self

Parameters:

Returns: self

Throws:

Source: src/Signature/Facade.php:56

emptyField()

Add an empty signature field (a clickable rectangle to be signed later).

public emptyField(
    float $posx = 0,
    float $posy = 0,
    float $width = 0,
    float $height = 0,
    int $page = -1,
    string $name = '',
    string $description = ''
): self

Parameters:

  • $posx (float): Abscissa of the upper-left corner.
  • $posy (float): Ordinate of the upper-left corner.
  • $width (float): Width of the signature area.
  • $height (float): Height of the signature area.
  • $page (int): Page number (if < 0 the current page is used).
  • $name (string): Name of the signature field.
  • $description (string): Description of the field, written as /TU in a tagged mode.

Returns: self

Throws:

Source: src/Signature/Facade.php:117

external()

Access the external / remote signing sub-facade.

public external(): External

Returns: External

Source: src/Signature/Facade.php:133

timestamp()

Configure the RFC 3161 signature timestamp (TSA).

public timestamp(TSignTimeStamp $data): self

Parameters:

Returns: self

Throws:

Source: src/Signature/Facade.php:69

upgradeToLta()

Request a PAdES B-LTA archive (adds the DSS and a /Type /DocTimeStamp archive timestamp on top of the signature). Requires a TSA configured via timestamp().

public upgradeToLta(): self

Returns: self

Source: src/Signature/Facade.php:90

userRights()

Set the document usage rights.

public userRights(TUserRights $rights): self

Parameters:

Returns: self

Source: src/Signature/Facade.php:80

widgetObjectId()

Return the signature widget annotation object id (0 if not initialized).

public widgetObjectId(): int

Returns: int

Source: src/Signature/Facade.php:141