Index

  1. \setasign\SetaPDF2
    1. Core
      1. XObject
        1. Form
        2. Image
        3. XObject

setasign\SetaPDF2\Core\XObject

Form Class representing a Form XObject

File: /SetaPDF v2/Core/XObject/Form.php
Old class name (alias): \SetaPDF_Core_XObject_Form

Class hierarchy

Implements

Summary

Static Methods

Methods

Properties

Constants

Constants

TYPE_COLOR_SPACE

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_COLOR_SPACE = 'ColorSpace'

Type constant

TYPE_EXT_G_STATE

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_EXT_G_STATE = 'ExtGState'

Type constant

TYPE_FONT

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_FONT = 'Font'

Type constant

TYPE_PATTERN

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_PATTERN = 'Pattern'

Type constant

TYPE_PROC_SET

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_PROC_SET = 'ProcSet'

Type constant

TYPE_PROPERTIES

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_PROPERTIES = 'Properties'

Type constant

TYPE_SHADING

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_SHADING = 'Shading'

Type constant

TYPE_X_OBJECT

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_X_OBJECT = 'XObject'

Type constant


Properties

$_bbox

protected Form::$_bbox

The BBox rectangle

$_canvas

protected \SetaPDF_Core_Canvas Form::$_canvas

The canvas object for this form XObject

$_indirectObject

protected \SetaPDF_Core_Type_IndirectObject XObject::$_indirectObject

The indirect object of the XObject


Static Methods

create()

public static Form::create (): \SetaPDF_Core_XObject_Form

Create an Form XObject.

Parameters
$document : \SetaPDF_Core_Document
 
$bbox : \SetaPDF_Core_DataStructure_Rectangle|array
 

freeCache()

public static XObject::freeCache (): void

Release XObject instances by a document instance.

Parameters
$document : \SetaPDF_Core_Document
 

get()

public static XObject::get (
\SetaPDF_Core_Type_IndirectObjectInterface $xObjectReference,
string $subType = null
): \SetaPDF_Core_XObject_Form|\SetaPDF_Core_XObject_Image

Get an external object by an indirect object/reference.

Parameters
$xObjectReference : \SetaPDF_Core_Type_IndirectObjectInterface
 
$subType : string
 
Exceptions

Throws \setasign\SetaPDF2\NotImplementedException


Methods

__construct()

public XObject::__construct ()

The constructor.

Parameters
$indirectObject : \SetaPDF_Core_Type_IndirectObjectInterface
 

_getBBox()

protected Form::_getBBox (
void
): \SetaPDF_Core_Geometry_Rectangle

Get the bounding box after applying the transformation matrix.

cleanUp()

public XObject::cleanUp (
void
): void

Release memory and cycled references.

draw()

public Form::draw (
\SetaPDF_Core_Canvas $canvas,
float $x = 0.0,
float $y = 0.0,
float $width = null,
float $height = null
): mixed|void

Draw the external object on the canvas.

Parameters
$canvas : \SetaPDF_Core_Canvas
 
$x : float
 
$y : float
 
$width : float
 
$height : float
 

ensureDefaultKeys()

public Form::ensureDefaultKeys (
void
): void

Ensures the default keys.

getBBox()

public Form::getBBox (
bool $asRect = true
): \SetaPDF_Core_DataStructure_Rectangle|\SetaPDF_Core_Type_Array

Get the BBox value or rectangle.

Parameters
$asRect : bool
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Core\Type\IndirectReference\Exception

getCanvas()

public Form::getCanvas (
void
): \SetaPDF_Core_Canvas

Get the canvas for this form XObject.

getGroup()

public Form::getGroup (
void
): ?\SetaPDF_Core_TransparencyGroup

Get a group attributes object.

getHeight()

public Form::getHeight (
float $width = null
): float

Get the height of the XObject.

Parameters
$width : float

To get the height in relation to a width value keeping the aspect ratio

See

getIndirectObject()

public XObject::getIndirectObject (
?\SetaPDF_Core_Document $document = null
): \SetaPDF_Core_Type_IndirectObject

Get the indirect object of this XObject.

Parameters
$document : ?\SetaPDF_Core_Document
 

getMatrix()

public Form::getMatrix (
bool $asArray = false
): bool|\SetaPDF_Core_Geometry_Matrix|array

Get the form matrix.

Parameters
$asArray : bool

Defines whether the matrix be returned as an array or as a matrix instance.

getObject()

public Form::getObject (
bool $observe = false
): \SetaPDF_Core_Type_IndirectObject

Get the indirect object of this XObject.

Parameters
$observe : bool
 

getResourceType()

public XObject::getResourceType (
void
): string

Get the resource type for external objects.

See

getStreamProxy()

public Form::getStreamProxy (
void
): \SetaPDF_Core_Canvas_StreamProxyInterface

Get the stream proxy.

getWidth()

public Form::getWidth (
float $height = null
): float

Get the width of the XObject.

Parameters
$height : float

To get the width in relation to a height value keeping the aspect ratio

See

setGroup()

public Form::setGroup (): void

Set the group attributes object.

Parameters
$group : false|\SetaPDF_Core_TransparencyGroup
 
Exceptions

Throws \InvalidArgumentException

setMatrix()

public Form::setMatrix (): void

Set the form matrix.

Parameters
$matrix : int[]|\SetaPDF_Core_Geometry_Matrix

An array of six numbers or a matrix instance.


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