Index

  1. \SetaPDF
    1. Stamper
    2. Stamper
      1. Stamp
      2. Stamp
        1. Image
        2. Pdf
        3. RichText
        4. Text
        5. XObject

SetaPDF_Stamper_Stamp_RichText The rich-text stamp class

File: /SetaPDF v2/Stamper/Stamp/RichText.php

With the stamp class you can add rich-text to an existing PDF document.

The text can be created by a subset of HTML and CSS style attributes.

Internally the class uses a SetaPDF_Core_Text_RichTextBlock object. Most methods of this class are proxy methods to the RichTextBlock instance.

Class hierarchy

Summary

Methods

Properties

Constants

Constants

VISIBILITY_ALL

public const string SetaPDF_Stamper_Stamp::VISIBILITY_ALL = 'all'

Visibility constant

VISIBILITY_PRINT

public const string SetaPDF_Stamper_Stamp::VISIBILITY_PRINT = 'print'

Visibility constant

VISIBILITY_VIEW

public const string SetaPDF_Stamper_Stamp::VISIBILITY_VIEW = 'view'

Visibility constant


Properties

$_action

protected SetaPDF_Core_Document_Action SetaPDF_Stamper_Stamp::$_action

The currently attached action object

$_blendMode

protected string SetaPDF_Stamper_Stamp::$_blendMode = 'Normal'

The blend mode

$_cacheCounter

protected integer SetaPDF_Stamper_Stamp::$_cacheCounter = 0

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

$_dataCache

protected array SetaPDF_Stamper_Stamp::$_dataCache

The cache data for the stamp

See

$_fonts

protected array SetaPDF_Stamper_Stamp_RichText::$_fonts = array()

An array holding font references

$_opacity

protected float SetaPDF_Stamper_Stamp::$_opacity = 1.0

The opacity

$_opacityGs

protected array SetaPDF_Stamper_Stamp::$_opacityGs = array()

Graphic state objects for handling transparency

Array of SetaPDF_Core_Resource_ExtGState objects

$_optionalContentGroup

protected SetaPDF_Core_Document_OptionalContent_Group SetaPDF_Stamper_Stamp::$_optionalContentGroup

An optional content groups that should be used for the stamp

$_richTextBlock

protected SetaPDF_Core_Text_RichTextBlock SetaPDF_Stamper_Stamp_RichText::$_richTextBlock

A richt text block instance

$_text

protected string SetaPDF_Stamper_Stamp_RichText::$_text = ''

$_visibility

protected string SetaPDF_Stamper_Stamp::$_visibility = 'all'

The visibility property


Methods

__construct()

public SetaPDF_Stamper_Stamp_RichText::__construct (
SetaPDF_Core_Document $document [, callable $fontLoader = null ]
)

The constructor.

Parameters
$document : SetaPDF_Core_Document
 
$fontLoader : callable
 

_cacheStampData()

protected SetaPDF_Stamper_Stamp::_cacheStampData (
string $cacheKey, string $stream, array $quadPoints
): void

Caches a content stream part.

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

_ensureResources()

protected SetaPDF_Stamper_Stamp_RichText::_ensureResources (): 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

See

_getOpacityGraphicState()

protected SetaPDF_Stamper_Stamp::_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 SetaPDF_Stamper_Stamp::_getVisibilityGroup (): false|SetaPDF_Core_Document_OptionalContent_Group

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

Parameters
$document : SetaPDF_Core_Document
 

_postStamp()

protected SetaPDF_Stamper_Stamp::_postStamp (
SetaPDF_Core_Document $document, SetaPDF_Core_Document_Page $page, array $stampData
): array|null

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

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

_preStamp()

protected SetaPDF_Stamper_Stamp::_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
 

_putAction()

protected SetaPDF_Stamper_Stamp::_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
 

_stamp()

protected SetaPDF_Stamper_Stamp_RichText::_stamp (
SetaPDF_Core_Document $document, SetaPDF_Core_Document_Page $page, array $stampData
): bool

Writes the content of this stamp onto the page canvas.

Parameters
$document : SetaPDF_Core_Document
 
$page : SetaPDF_Core_Document_Page
 
$stampData : array
 
Exceptions

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_Font_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Type_IndirectReference_Exception

Throws SetaPDF_Exception_NotImplemented

_stampByCache()

protected SetaPDF_Stamper_Stamp_RichText::_stampByCache (
SetaPDF_Core_Document $document, SetaPDF_Core_Document_Page $page, array $stampData
): bool|string|true
Parameters
$document : SetaPDF_Core_Document
 
$page : SetaPDF_Core_Document_Page
 
$stampData : array
 
Exceptions

Throws SetaPDF_Core_Exception

Throws SetaPDF_Stamper_Exception

getAction()

public SetaPDF_Stamper_Stamp::getAction (
void
): null|SetaPDF_Core_Document_Action

Get the current attached action.

getAlign()

public SetaPDF_Stamper_Stamp_RichText::getAlign (
void
): string

Get the text alignment.

See

getBackgroundColor()

public SetaPDF_Stamper_Stamp_RichText::getBackgroundColor (
void
): SetaPDF_Core_DataStructure_Color|null
See

getBorderColor()

public SetaPDF_Stamper_Stamp_RichText::getBorderColor (
void
): SetaPDF_Core_DataStructure_Color|SetaPDF_Core_DataStructure_Color_Gray|null
See

getBorderWidth()

public SetaPDF_Stamper_Stamp_RichText::getBorderWidth (
void
): float|int
See

getDefaultFontFamily()

public SetaPDF_Stamper_Stamp_RichText::getDefaultFontFamily (
void
): string
See

getDefaultFontSize()

public SetaPDF_Stamper_Stamp_RichText::getDefaultFontSize (
void
): float|int
See

getDefaultLineHeight()

public SetaPDF_Stamper_Stamp_RichText::getDefaultLineHeight (
void
): float|int
See

getDefaultTextColor()

public SetaPDF_Stamper_Stamp_RichText::getDefaultTextColor (
void
): array|float|int|SetaPDF_Core_DataStructure_Color|SetaPDF_Core_Type_Array|string
See

getDimensions()

public SetaPDF_Stamper_Stamp::getDimensions (
void
): array

Get the stamp dimension.

getHeight()

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

Get the height of this stamp.

Proxy method to SetaPDF_Core_Text_RichTextBlock::getHeight() of the rich-text block instance.

Exceptions

Throws SetaPDF_Core_Exception

See

getOpacity()

public SetaPDF_Stamper_Stamp::getOpacity (
void
): number

Get the opacity.

getOpacityBlendMode()

public SetaPDF_Stamper_Stamp::getOpacityBlendMode (
void
): string

Get the blend mode.

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

getOptionalContentGroup()

public SetaPDF_Stamper_Stamp::getOptionalContentGroup (
void
): SetaPDF_Core_Document_OptionalContent_Group

Get the optional content group for this stamp.

getOriginX()

public SetaPDF_Stamper_Stamp::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 SetaPDF_Stamper::POSITION_XXX

getOriginY()

public SetaPDF_Stamper_Stamp::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 SetaPDF_Stamper::POSITION_XXX

getPaddingBottom()

public SetaPDF_Stamper_Stamp_RichText::getPaddingBottom (
void
): float|int

Get the bottom padding.

See

getPaddingLeft()

public SetaPDF_Stamper_Stamp_RichText::getPaddingLeft (
void
): float|int

Get the left padding.

See

getPaddingRight()

public SetaPDF_Stamper_Stamp_RichText::getPaddingRight (
void
): float|int

Get the right padding.

See

getPaddingTop()

public SetaPDF_Stamper_Stamp_RichText::getPaddingTop (
void
): float|int

Get the top padding.

See

getRichTextBlock()

public SetaPDF_Stamper_Stamp_RichText::getRichTextBlock (
void
): SetaPDF_Core_Text_RichTextBlock

Access the rich-text block instance.

IF YOU MAKE CHANGES OUTSIDE THE STAMP CLASS, MAKE SURE THAT YOU CALL {updateCacheCounter()} AFTERWARDS.

getText()

public SetaPDF_Stamper_Stamp_RichText::getText (
void
): string

getTextWidth()

public SetaPDF_Stamper_Stamp_RichText::getTextWidth (
void
): int|float

Returns the width of the rich-text stamp without padding.

Exceptions

Throws SetaPDF_Core_Exception

See

getVisibility()

public SetaPDF_Stamper_Stamp::getVisibility (
void
): null|string

Get the visibility of the stamp object.

getWidth()

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

Get the width of this stamp.

Proxy method to SetaPDF_Core_Text_RichTextBlock::getWidth() of the rich-text block instance.

Exceptions

Throws SetaPDF_Core_Exception

See

setAction()

public SetaPDF_Stamper_Stamp::setAction (): void

Add an action object to the stamp object.

Parameters
$action : SetaPDF_Core_Document_Action

The action object

setAlign()

public SetaPDF_Stamper_Stamp_RichText::setAlign (
string $align
): void

Set the text alignment.

Parameters
$align : string
 
See

setBackgroundColor()

public SetaPDF_Stamper_Stamp_RichText::setBackgroundColor (): void

Set the background color.

Parameters
$color : SetaPDF_Core_DataStructure_Color|int|float|string|array|SetaPDF_Core_Type_Array
 
See

setBorderColor()

public SetaPDF_Stamper_Stamp_RichText::setBorderColor (): void

Set the border color.

Parameters
$color : SetaPDF_Core_DataStructure_Color|int|float|string|array|SetaPDF_Core_Type_Array
 
See

setBorderWidth()

public SetaPDF_Stamper_Stamp_RichText::setBorderWidth (
int|float $borderWidth
): void

Set the border width.

Parameters
$borderWidth : int|float
 
See

setDefaultFontFamily()

public SetaPDF_Stamper_Stamp_RichText::setDefaultFontFamily (
string $fontFamily
): void
Parameters
$fontFamily : string
 
See

setDefaultFontSize()

public SetaPDF_Stamper_Stamp_RichText::setDefaultFontSize (
int|float $fontSize
): void
Parameters
$fontSize : int|float
 
See

setDefaultLineHeight()

public SetaPDF_Stamper_Stamp_RichText::setDefaultLineHeight (
int|float $lineHeight
): void
Parameters
$lineHeight : int|float

Only unitless line-heights are supported here like 1 or 1.4

setDefaultTextColor()

public SetaPDF_Stamper_Stamp_RichText::setDefaultTextColor (): void
Parameters
$color : int|float|string|array|SetaPDF_Core_Type_Array|SetaPDF_Core_DataStructure_Color
 
See

setLink()

public SetaPDF_Stamper_Stamp::setLink (
string $uri
): void

Set a link onto the stamp.

Parameters
$uri : string

The link

See

setOpacity()

public SetaPDF_Stamper_Stamp::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 SetaPDF_Stamper_Stamp::setOptionalContentGroup (
[ SetaPDF_Core_Document_OptionalContent_Group|null $optionalContentGroup = null ]
): void

Set the optional content group for this stamp.

Parameters
$optionalContentGroup : SetaPDF_Core_Document_OptionalContent_Group|null
 

setPadding()

public SetaPDF_Stamper_Stamp_RichText::setPadding (
int|float $padding
): void

Set the padding.

Parameters
$padding : int|float
 
See

setPaddingBottom()

public SetaPDF_Stamper_Stamp_RichText::setPaddingBottom (
int|float $paddingBottom
): void

Set the bottom padding.

Parameters
$paddingBottom : int|float
 
See

setPaddingLeft()

public SetaPDF_Stamper_Stamp_RichText::setPaddingLeft (
int|float $paddingLeft
): void

Set the left padding.

Parameters
$paddingLeft : int|float
 
See

setPaddingRight()

public SetaPDF_Stamper_Stamp_RichText::setPaddingRight (
int|float $paddingRight
): void

Set the right padding.

Parameters
$paddingRight : int|float
 
See

setPaddingTop()

public SetaPDF_Stamper_Stamp_RichText::setPaddingTop (
int|float $paddingTop
): void

Set the top padding.

Parameters
$paddingTop : int|float
 
See

setText()

public SetaPDF_Stamper_Stamp_RichText::setText (
string $text [, string $locale = 'en_US' ]
): void
Parameters
$text : string

A UTF-8 string with a subset of HTML tags and CSS properties in style-parameter.

$locale : string

INTL locale used for the break behaviour

See

setTextWidth()

public SetaPDF_Stamper_Stamp_RichText::setTextWidth (
int|float $width
): void

Set the width of the text in the rich-text stamp. Padding is not included in this width.

Parameters
$width : int|float
 
See

setVisibility()

public SetaPDF_Stamper_Stamp::setVisibility (
null|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 : null|string

Use the constants VISIBILITY_XXX or null(equal to VISIBILITY_ALL)

Exceptions

Throws InvalidArgumentException

stamp()

public SetaPDF_Stamper_Stamp::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

updateCacheCounter()

public SetaPDF_Stamper_Stamp::updateCacheCounter (
void
): void

Updates the cache counter.


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