Index

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

setasign\SetaPDF2\Stamper\Stamp

XObjectStamp The XObject stamp class

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

This stamp class is able to use a \setasign\SetaPDF2\Core\XObject\XObject instance as its stamp appearance. XObjects could be images or so called form XObjects.

A form XObject is a PDF content stream that is a self-contained description of any sequence of graphics objects (including path objects, text objects and sampled images).

This stamp class allows you to stamp separately form XObjects or image XObjects. A form XObject could include for example drawing operations:

// Create a form XObject with the dimensions of 100 x 100
$xObject = \setasign\SetaPDF2\Core\XObject\Form::create($document, array(0, 0, 100, 100));
$canvas = $xObject->getCanvas();
$canvas->path()->setLineWidth(1);
$canvas->draw()
    ->rect(0, 0, 100, 100) // Draw a rectangle into the form XObject
    ->circle(50, 50, 50); // Draw a circle into the form XObject

$stamp = new \setasign\SetaPDF2\Stamper\Stamp\XObject($xObject);

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

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

$_height

protected float|int XObjectStamp::$_height

The individual height of the image

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

$_visibility

protected string AbstractStamp::$_visibility = 'all'

The visibility property

$_width

protected float|int XObjectStamp::$_width

The individual width of the image

$_xObject

protected \setasign\SetaPDF2\Core\XObject\XObject XObjectStamp::$_xObject

The XObject instance


Methods

__construct()

public XObjectStamp::__construct ()

The constructor.

Parameters
$xObject : \setasign\SetaPDF2\Core\XObject\XObject

The xobject instance

_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 XObjectStamp::_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
 

_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 XObjectStamp::_stamp (): bool

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

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

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

cleanUp()

public XObjectStamp::cleanUp (
void
): void

Release resources / cycled references.

getAction()

public AbstractStamp::getAction (
void
): ?\setasign\SetaPDF2\Core\Document\Action\Action

Get the current attached action.

getDimensions()

public AbstractStamp::getDimensions (
void
): array

Get the stamp dimension.

getHeight()

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

Get the height of the XObject stamp.

If no individual height is given the height will be received from the XObject object by forwarding an individual width (if available) to keep the aspect ratio.

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

getVisibility()

public AbstractStamp::getVisibility (
void
): ?string

Get the visibility of the stamp object.

getWidth()

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

Get the width of the XObject stamp.

If no individual width is given the width will be received from the XObject object by forwarding an individual height (if available) to keep the aspect ratio.

getXObject()

public XObjectStamp::getXObject (
void
): \setasign\SetaPDF2\Core\XObject\XObject

Get the XObject 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

setDimensions()

public XObjectStamp::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 XObjectStamp::setHeight (
float|int $height
): void

Set the individual height if the XObject 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
 

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 XObjectStamp::setWidth (
float|int $width
): void

Set the individual width of the XObject stamp.

Parameters
$width : float|int

The new width

setXObject()

public XObjectStamp::setXObject (): void

Set the XObject.

Parameters
$xObject : \setasign\SetaPDF2\Core\XObject\XObject

The new xobject instance

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)