Index

  1. \setasign\SetaPDF2
    1. Stamper
      1. Stamp
        1. AbstractStamp
        2. ImageStamp
        3. PdfStamp
        4. RichTextStamp
        5. TextStamp
        6. XObjectStamp

setasign\SetaPDF2\Stamper\Stamp

PdfStamp The PDF stamp class

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

To initiate an instance it is needed to pass a document instance to the constructor. The second parameter could be used to set the page number of the page which will be used as the stamp appearance.

$document = \setasign\SetaPDF2\Core\Document::loadByFilename('path/to/document.pdf');
$stamp = new \setasign\SetaPDF2\Stamper\Stamp\Pdf($document, 2); // use page 2

Class hierarchy

Summary

Methods

Properties

Constants

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 \setasign\SetaPDF2\Core\Document\Action\Action AbstractStamp::$_action

The currently attached action object

$_blendMode

protected string AbstractStamp::$_blendMode = 'Normal'

The blend mode

$_boundaryBox

protected string PdfStamp::$_boundaryBox = 'CropBox'

The boundary box to use

$_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

$_document

protected \setasign\SetaPDF2\Core\Document PdfStamp::$_document

The document instance

$_height

protected float|int PdfStamp::$_height

The individual height of the page

$_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 \setasign\SetaPDF2\Core\Document\OptionalContent\Group AbstractStamp::$_optionalContentGroup

An optional content groups that should be used for the stamp

$_pageNumber

protected int PdfStamp::$_pageNumber

The page number

$_visibility

protected string AbstractStamp::$_visibility = 'all'

The visibility property

$_width

protected float|int PdfStamp::$_width

The individual width of the page

$_xObject

protected \setasign\SetaPDF2\Core\XObject\Form PdfStamp::$_xObject

The XObject of the page


Methods

__construct()

public PdfStamp::__construct (
\setasign\SetaPDF2\Core\Document|string $filenameOrDocument,
int $pageNumber = 1,
string $boundaryBox = \setasign\SetaPDF2\Core\PageBoundaries::CROP_BOX
)

The constructor.

Parameters
$filenameOrDocument : \setasign\SetaPDF2\Core\Document|string

Filename of the pdf or a document instance of the pdf

$pageNumber : int

The page number for the page which should be used for the stamp appearance

$boundaryBox : string

Use the boundary constants \setasign\SetaPDF2\Core\PageBoundaries::XXX_BOX

Exceptions

Throws \setasign\SetaPDF2\Core\Parser\CrossReferenceTable\Exception

Throws \setasign\SetaPDF2\Core\Reader\Exception

_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 PdfStamp::_ensureResources (): array

Ensures that all stamp resources are added to the page.

This is needed to reuse a cached stamp stream.

Parameters
$document : \setasign\SetaPDF2\Core\Document
 
$page : \setasign\SetaPDF2\Core\Document\Page
 
Return Values

An array of resource names

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

See

_getOpacityGraphicState()

protected AbstractStamp::_getOpacityGraphicState (
\setasign\SetaPDF2\Core\Document $document,
float $opacity
): \setasign\SetaPDF2\Core\Resource\ExtGState

Get and caches opacity graphic states.

Parameters
$document : \setasign\SetaPDF2\Core\Document
 
$opacity : float
 

_getPage()

protected PdfStamp::_getPage (
void
): \setasign\SetaPDF2\Core\Document\Page

Get the page object.

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

_getVisibilityGroup()

protected AbstractStamp::_getVisibilityGroup (): false|\setasign\SetaPDF2\Core\Document\OptionalContent\Group

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

Parameters
$document : \setasign\SetaPDF2\Core\Document
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

_postStamp()

protected AbstractStamp::_postStamp (): ?array

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

Parameters
$document : \setasign\SetaPDF2\Core\Document
 
$page : \setasign\SetaPDF2\Core\Document\Page
 
$stampData : array
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

_preStamp()

protected AbstractStamp::_preStamp (): void

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

Parameters
$document : \setasign\SetaPDF2\Core\Document
 
$page : \setasign\SetaPDF2\Core\Document\Page
 
$stampData : array
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

_putAction()

protected AbstractStamp::_putAction (
\setasign\SetaPDF2\Core\Document $document,
\setasign\SetaPDF2\Core\Document\Page $page,
array $stampData,
array{x: number, y: number} $xy1,
array{x: number, y: number} $xy2,
array{x: number, y: number} $xy3,
array{x: number, y: number} $xy4
): void

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

Parameters
$document : \setasign\SetaPDF2\Core\Document
 
$page : \setasign\SetaPDF2\Core\Document\Page
 
$stampData : array
 
$xy1 : array{x: number, y: number}
 
$xy2 : array{x: number, y: number}
 
$xy3 : array{x: number, y: number}
 
$xy4 : array{x: number, y: number}
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

_stamp()

protected PdfStamp::_stamp (): bool

Writes the xobject draw operators of this stamp onto the canvas.

A page is internally converted into a xobject.

Parameters
$document : \setasign\SetaPDF2\Core\Document
 
$page : \setasign\SetaPDF2\Core\Document\Page
 
$stampData : array
 
Exceptions

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

_stampByCache()

protected AbstractStamp::_stampByCache (): true|string

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

Parameters
$document : \setasign\SetaPDF2\Core\Document
 
$page : \setasign\SetaPDF2\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
): ?\setasign\SetaPDF2\Core\Document\Action\Action

Get the current attached action.

getBoundaryBox()

public PdfStamp::getBoundaryBox (
void
): string

Get the current boundary box name.

getDimensions()

public AbstractStamp::getDimensions (
void
): array

Get the stamp dimension.

getDocument()

public PdfStamp::getDocument (
void
): \setasign\SetaPDF2\Core\Document

Get the document instance.

getHeight()

public PdfStamp::getHeight (
void
): float|int

Get the height of the pdf page stamp.

If no individual height is given the height will be received from the page object. Also a defined individual width (if available) will be used to keep the aspect ratio.

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

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
): \setasign\SetaPDF2\Core\Document\OptionalContent\Group

Get the optional content group for this stamp.

getOriginX()

public AbstractStamp::getOriginX (
\setasign\SetaPDF2\Core\Document\Page $page,
string $position
): float|int

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

Parameters
$page : \setasign\SetaPDF2\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 (
\setasign\SetaPDF2\Core\Document\Page $page,
string $position
): float|int

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

Parameters
$page : \setasign\SetaPDF2\Core\Document\Page

The page instance

$position : string

Position constant \setasign\SetaPDF2\Stamper\Stamper::POSITION_XXX

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getPageNumber()

public PdfStamp::getPageNumber (
void
): int

Get the page number of the page that should be used for the stamp appearance.

getVisibility()

public AbstractStamp::getVisibility (
void
): ?string

Get the visibility of the stamp object.

getWidth()

public PdfStamp::getWidth (
void
): float|int

Get the width of the pdf page stamp.

If no individual width is given the width will be received from the page object. Also a defined individual height (if available) will be used to keep the aspect ratio.

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

getXObject()

public PdfStamp::getXObject (): \setasign\SetaPDF2\Core\XObject\Form

Get the form XObject from the page object.

Parameters
$document : \setasign\SetaPDF2\Core\Document

The document instance

setAction()

public AbstractStamp::setAction (): void

Add an action object to the stamp object.

Parameters
$action : \setasign\SetaPDF2\Core\Document\Action\Action

The action object

setBoundaryBox()

public PdfStamp::setBoundaryBox (
string $boundaryBox
): void

Set the boundary box of the imported page.

Parameters
$boundaryBox : string

Use the boundary constants \setasign\SetaPDF2\Core\PageBoundaries::XXX_BOX

setDimensions()

public PdfStamp::setDimensions (
float|int $width,
float|int $height
): void

Set the dimensions of this stamp.

Parameters
$width : float|int

The new width

$height : float|int

The new height

setHeight()

public PdfStamp::setHeight (
float|int $height
): void

Set the individual height if the pdf page stamp.

Parameters
$height : float|int

The new height

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

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 (): void

Set the optional content group for this stamp.

Parameters
$optionalContentGroup : ?\setasign\SetaPDF2\Core\Document\OptionalContent\Group
 

setPageNumber()

public PdfStamp::setPageNumber (
int $pageNumber
): void

Set the page number for the page which should be used for the stamp appearance.

Parameters
$pageNumber : int

The page number

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

setWidth()

public PdfStamp::setWidth (
float|int $width
): void

Set the individual width of the pdf page stamp.

Parameters
$width : float|int

The new width

stamp()

public AbstractStamp::stamp (): bool

Stamp this stamp object onto a page.

Parameters
$document : \setasign\SetaPDF2\Core\Document

The document object

$page : \setasign\SetaPDF2\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.


© 2025 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)