SetaPDF_Core_XObject Abstract class representing an external object

File: /SetaPDF v2/Core/XObject.php

Class hierarchy

Implements

Summary

Constants

TYPE_COLOR_SPACE

const SetaPDF_Core_XObject::TYPE_COLOR_SPACE = 'ColorSpace'

TYPE_EXT_G_STATE

const SetaPDF_Core_XObject::TYPE_EXT_G_STATE = 'ExtGState'

TYPE_FONT

const SetaPDF_Core_XObject::TYPE_FONT = 'Font'

TYPE_PATTERN

const SetaPDF_Core_XObject::TYPE_PATTERN = 'Pattern'

TYPE_PROC_SET

const SetaPDF_Core_XObject::TYPE_PROC_SET = 'ProcSet'

TYPE_PROPERTIES

const SetaPDF_Core_XObject::TYPE_PROPERTIES = 'Properties'

TYPE_SHADING

const SetaPDF_Core_XObject::TYPE_SHADING = 'Shading'

TYPE_X_OBJECT

const SetaPDF_Core_XObject::TYPE_X_OBJECT = 'XObject'


Static Properties

$_xObjects

static protected array SetaPDF_Core_XObject::$_xObjects = array()

An array caching XObject objects


Properties

$_indirectObject

protected SetaPDF_Core_Type_IndirectObject SetaPDF_Core_XObject::$_indirectObject

The indirect object of the XObject


Static Methods

freeCache()

public static SetaPDF_Core_XObject::freeCache (): void

Release XObject instances by a document instance.

Parameters
$document : SetaPDF_Core_Document
 

get()

Get an external object by an indirect object/reference.

Parameters
$xObjectReference : SetaPDF_Core_Type_IndirectObjectInterface
 
$subType : string
 
Exceptions

Throws SetaPDF_Exception_NotImplemented


Methods

__construct()

The constructor.

Parameters
$indirectObject : SetaPDF_Core_Type_IndirectObjectInterface
 

cleanUp()

public SetaPDF_Core_XObject::cleanUp (
void
): void

Release memory and cycled references.

draw()

abstract public SetaPDF_Core_XObject::draw (
SetaPDF_Core_Canvas $canvas [, int $x = 0 [, int $y = 0 [, null|float $width = null [, null|float $height = null ]]]]
): mixed

Draw the external object on the canvas.

Parameters
$canvas : SetaPDF_Core_Canvas
 
$x : int
 
$y : int
 
$width : null|float
 
$height : null|float
 

getIndirectObject()

Get the indirect object of this XObject.

Parameters
$document : SetaPDF_Core_Document|null
 

getResourceType()

public SetaPDF_Core_XObject::getResourceType (
void
): string

Get the resource type for external objects.

See