Class Image in namespace setasign\SetaPDF2\Core\XObject in SetaPDF v2 API Reference

Index

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

setasign\SetaPDF2\Core\XObject

Image Class representing an Image XObject

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

Class hierarchy

XObject
- Image

Implements

\setasign\SetaPDF2\Core\Resource\ResourceInterface

Summary

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

$_indirectObject

protected \SetaPDF_Core_Type_IndirectObject XObject::$_indirectObject

The indirect object of the XObject

Static Methods

create()

public static 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 XObject::freeCache (

\SetaPDF_Core_Document $document

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

\SetaPDF_Core_Type_IndirectObjectInterface $indirectObject

)

The constructor.

Parameters

$indirectObject : \SetaPDF_Core_Type_IndirectObjectInterface

cleanUp()

public XObject::cleanUp (

void

): void

Release memory and cycled references.

draw()

public 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 Image::getBitsPerComponent (

void

): bool|int

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

getColorSpace()

public Image::getColorSpace (

bool $pdfValue = false

Get the color space of this image.

Parameters

$pdfValue : bool

Exceptions

Throws \setasign\SetaPDF2\NotImplementedException

getHeight()

public 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 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 XObject::getResourceType (

void

): string

Get the resource type for external objects.

See

\setasign\SetaPDF2\Core\Resource\ResourceInterface::getResourceType()

getWidth()

public 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