SetaPDF_Core_XObject_Image Class representing an Image XObject

File: /SetaPDF v2/Core/XObject/Image.php

Class hierarchy

Implements

Summary

Constants

TYPE_COLOR_SPACE

public const string SetaPDF_Core_Resource::TYPE_COLOR_SPACE = 'ColorSpace'

Type constant

TYPE_EXT_G_STATE

public const string SetaPDF_Core_Resource::TYPE_EXT_G_STATE = 'ExtGState'

Type constant

TYPE_FONT

public const string SetaPDF_Core_Resource::TYPE_FONT = 'Font'

Type constant

TYPE_PATTERN

public const string SetaPDF_Core_Resource::TYPE_PATTERN = 'Pattern'

Type constant

TYPE_PROC_SET

public const string SetaPDF_Core_Resource::TYPE_PROC_SET = 'ProcSet'

Type constant

TYPE_PROPERTIES

public const string SetaPDF_Core_Resource::TYPE_PROPERTIES = 'Properties'

Type constant

TYPE_SHADING

public const string SetaPDF_Core_Resource::TYPE_SHADING = 'Shading'

Type constant

TYPE_X_OBJECT

public const string SetaPDF_Core_Resource::TYPE_X_OBJECT = 'XObject'

Type constant


Properties

$_indirectObject

The indirect object of the XObject


Static Methods

create()

Create an image xobject by a reader object.

Parameters
$document : SetaPDF_Core_Document
 
$reader : SetaPDF_Core_Reader_ReaderInterface
 

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

public SetaPDF_Core_XObject_Image::draw (
SetaPDF_Core_Canvas $canvas [, float $x = 0.0 [, float $y = 0.0 [, float $width = null [, float $height = null ]]]]
): void

Draw the external object on the canvas.

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

getBitsPerComponent()

Get the number of bits used to represen each colour component.

getHeight()

public SetaPDF_Core_XObject_Image::getHeight (
[ float $width = null ]
): float

Get the height of the image.

Parameters
$width : float

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

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

getWidth()

public SetaPDF_Core_XObject_Image::getWidth (
[ float $height = null ]
): float

Get the width of the image.

Parameters
$height : float

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