Abstract Class setasign\SetaPDF2\Stamper\Stamp\AbstractStamp in SetaPDF v2 API Reference

Index

\setasign\SetaPDF2
1. Stamper
  1. Stamp

setasign\SetaPDF2\Stamper\Stamp

AbstractStamp The abstract base stamp class

File: /SetaPDF v2/Stamper/Stamp/AbstractStamp.php
Old class name (alias): \SetaPDF_Stamper_Stamp

Class hierarchy

AbstractStamp

Summary

Constants

VISIBILITY_ALL

public const string AbstractStamp::VISIBILITY_ALL = 'all'

Visibility constant

VISIBILITY_PRINT

public const string AbstractStamp::VISIBILITY_PRINT = 'print'

Visibility constant

VISIBILITY_VIEW

public const string AbstractStamp::VISIBILITY_VIEW = 'view'

Visibility constant

Properties

$_action

protected \SetaPDF_Core_Document_Action AbstractStamp::$_action

The currently attached action object

$_blendMode

protected string AbstractStamp::$_blendMode = 'Normal'

The blend mode

$_cacheCounter

protected int AbstractStamp::$_cacheCounter = 0

An internal used id for forcing a recreation if a property was changed

$_dataCache

protected array AbstractStamp::$_dataCache

The cache data for the stamp

See

AbstractStamp::_cacheStampData()

$_opacity

protected float AbstractStamp::$_opacity = 1.0

The opacity

$_opacityGs

protected array AbstractStamp::$_opacityGs = array()

Graphic state objects for handling transparency

Array of \setasign\SetaPDF2\Core\Resource\ExtGState objects

$_optionalContentGroup

protected \SetaPDF_Core_Document_OptionalContent_Group AbstractStamp::$_optionalContentGroup

An optional content groups that should be used for the stamp

$_visibility

protected string AbstractStamp::$_visibility = 'all'

The visibility property

Methods

_cacheStampData()

protected AbstractStamp::_cacheStampData (

string $cacheKey,
string $stream,
array $quadPoints

): void

Caches a content stream part.

Parameters

$cacheKey : string
$stream : string
$quadPoints : array

_ensureResources()

protected AbstractStamp::_ensureResources (

\SetaPDF_Core_Document $document,
\SetaPDF_Core_Document_Page $page

): array

Ensures that all stamp resources are added to the page.

This is needed to reuse a cached stamp stream.

Parameters

$document : \SetaPDF_Core_Document
$page : \SetaPDF_Core_Document_Page

Return Values

An array of resource names

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

_getOpacityGraphicState()

protected AbstractStamp::_getOpacityGraphicState (

\SetaPDF_Core_Document $document,
float $opacity

): \SetaPDF_Core_Resource_ExtGState

Get and caches opacity graphic states.

Parameters

$document : \SetaPDF_Core_Document
$opacity : float

_getVisibilityGroup()

protected AbstractStamp::_getVisibilityGroup (

\SetaPDF_Core_Document $document

): false|\SetaPDF_Core_Document_OptionalContent_Group

Get and adds the visibility group of this stamp to a document.

Parameters

$document : \SetaPDF_Core_Document

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

_postStamp()

protected AbstractStamp::_postStamp (

\SetaPDF_Core_Document $document,
\SetaPDF_Core_Document_Page $page,
array $stampData

): ?array

Method which is called after the main stamp method is executed.

Parameters

$document : \SetaPDF_Core_Document
$page : \SetaPDF_Core_Document_Page
$stampData : array

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

_preStamp()

protected AbstractStamp::_preStamp (

\SetaPDF_Core_Document $document,
\SetaPDF_Core_Document_Page $page,
array $stampData

): void

Method which is called before the main stamp method is executed.

Parameters

$document : \SetaPDF_Core_Document
$page : \SetaPDF_Core_Document_Page
$stampData : array

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

_putAction()

protected AbstractStamp::_putAction (

\SetaPDF_Core_Document $document,
\SetaPDF_Core_Document_Page $page,
array $stampData,
number $xy1,
number $xy2,
number $xy3,
number $xy4

): void

Put the action via an link annotation above the stamp object.

Parameters

$document : \SetaPDF_Core_Document
$page : \SetaPDF_Core_Document_Page
$stampData : array
$xy1 : number
$xy2 : number
$xy3 : number
$xy4 : number

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

_stamp()

abstract protected AbstractStamp::_stamp (

\SetaPDF_Core_Document $document,
\SetaPDF_Core_Document_Page $page,
array $stampData

): bool

Stamp this stamp object onto a page.

Parameters

$document : \SetaPDF_Core_Document
$page : \SetaPDF_Core_Document_Page
$stampData : array

_stampByCache()

protected AbstractStamp::_stampByCache (

\SetaPDF_Core_Document $document,
\SetaPDF_Core_Document_Page $page,
array $stampData

): true|string

Try to stamp with the page with a cached content stream part.

Parameters

$document : \SetaPDF_Core_Document
$page : \SetaPDF_Core_Document_Page
$stampData : array

Return Values

True if the stamp was written by a cache object, a cache key if it was not found

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Stamper\Exception

getAction()

public AbstractStamp::getAction (

void

): ?\SetaPDF_Core_Document_Action

Get the current attached action.

getDimensions()

public AbstractStamp::getDimensions (

void

): array

Get the stamp dimension.

getHeight()

abstract public AbstractStamp::getHeight (

void

): float|int

Get the height of the stamp object.

getOpacity()

public AbstractStamp::getOpacity (

void

): float

Get the opacity.

getOpacityBlendMode()

public AbstractStamp::getOpacityBlendMode (

void

): string

Get the blend mode.

See

PDF 32000-1:2008 - 11.3.5, "Blend Mode"

getOptionalContentGroup()

public AbstractStamp::getOptionalContentGroup (

void

): \SetaPDF_Core_Document_OptionalContent_Group

Get the optional content group for this stamp.

getOriginX()

public AbstractStamp::getOriginX (

\SetaPDF_Core_Document_Page $page,
string $position

): float|int

Get the x-origin in view to the position of the stamp object.

Parameters

$page : \SetaPDF_Core_Document_Page: The page instance
$position : string: Position constant \setasign\SetaPDF2\Stamper\Stamper::POSITION_XXX

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getOriginY()

public AbstractStamp::getOriginY (

\SetaPDF_Core_Document_Page $page,
string $position

): float|int

Get the y-origin in view to the position of the stamp object.

Parameters

$page : \SetaPDF_Core_Document_Page: The page instance
$position : string: Position constant \setasign\SetaPDF2\Stamper\Stamper::POSITION_XXX

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getVisibility()

public AbstractStamp::getVisibility (

void

): ?string

Get the visibility of the stamp object.

getWidth()

abstract public AbstractStamp::getWidth (

void

): float|int

Get the width of the stamp object.

setAction()

public AbstractStamp::setAction (

\SetaPDF_Core_Document_Action $action

): void

Add an action object to the stamp object.

Parameters

$action : \SetaPDF_Core_Document_Action: The action object

setLink()

public AbstractStamp::setLink (

string $uri

): void

Set a link onto the stamp.

Parameters

$uri : string: The link

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

See

AbstractStamp::setAction()

setOpacity()

public AbstractStamp::setOpacity (

float $alpha,
string $blendMode = 'Normal'

): void

Set the opacity and blend mode of the stamp object.

Parameters

$alpha : float: A value between 0 and 1, whereas 1 is defined as 100% opacity
$blendMode : string: A blend mode defined in PDF 32000-1:2008 - 11.3.5, "Blend Mode"

Exceptions

Throws \InvalidArgumentException

setOptionalContentGroup()

public AbstractStamp::setOptionalContentGroup (

?\SetaPDF_Core_Document_OptionalContent_Group $optionalContentGroup = null

): void

Set the optional content group for this stamp.

Parameters

$optionalContentGroup : ?\SetaPDF_Core_Document_OptionalContent_Group

setVisibility()

public AbstractStamp::setVisibility (

?string $visibility

): void

Set the visibility of the stamp object.

This method controls the visibility of the stamp object on screen view and/or printer output.

Parameters

$visibility : ?string: Use the constants VISIBILITY_XXX or null(equal to VISIBILITY_ALL)

Exceptions

Throws \InvalidArgumentException

stamp()

public AbstractStamp::stamp (

\SetaPDF_Core_Document $document,
\SetaPDF_Core_Document_Page $page,
array $stampData

): bool

Stamp this stamp object onto a page.

Parameters

$document : \SetaPDF_Core_Document: The document object
$page : \SetaPDF_Core_Document_Page: The page object
$stampData : array: The stampData array

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Stamper\Exception

updateCacheCounter()

public AbstractStamp::updateCacheCounter (

void

): void

Updates the cache counter.