Class SetaPDF_Core_XObject_Image in SetaPDF v2 API Reference

Index

\SetaPDF
1. Core
2. Core
  1. XObject
  2. XObject
    1. Form
    2. Image

SetaPDF_Core_XObject_Image Class representing an Image XObject

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

Class hierarchy

SetaPDF_Core_XObject
- SetaPDF_Core_XObject_Image

Implements

SetaPDF_Core_Resource

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

protected SetaPDF_Core_Type_IndirectObject SetaPDF_Core_XObject::$_indirectObject

The indirect object of the XObject

Static Methods

create()

public static SetaPDF_Core_XObject_Image::create (

SetaPDF_Core_Document $document,
SetaPDF_Core_Reader_ReaderInterface $reader

): SetaPDF_Core_XObject_Image

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 (

SetaPDF_Core_Document $document

): void

Release XObject instances by a document instance.

Parameters

$document : SetaPDF_Core_Document

get()

public static SetaPDF_Core_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 SetaPDF_Exception_NotImplemented

Methods

__construct()

public SetaPDF_Core_XObject::__construct (

SetaPDF_Core_Type_IndirectObjectInterface $indirectObject

)

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

public SetaPDF_Core_XObject_Image::getBitsPerComponent (

void

): bool|int

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

getColorSpace()

public SetaPDF_Core_XObject_Image::getColorSpace (

bool $pdfValue = false

Get the color space of this image.

Parameters

$pdfValue : bool

Exceptions

Throws SetaPDF_Exception_NotImplemented

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

public SetaPDF_Core_XObject::getIndirectObject (

?SetaPDF_Core_Document $document = null

): SetaPDF_Core_Type_IndirectObject

Get the indirect object of this XObject.

Parameters

$document : ?SetaPDF_Core_Document

getResourceType()

public SetaPDF_Core_XObject::getResourceType (

void

): string

Get the resource type for external objects.

See

SetaPDF_Core_Resource::getResourceType()

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