Abstract Class SetaPDF_Core_Image in SetaPDF v2 API Reference

Index

\SetaPDF
1. Core
2. Core
  1. Image
  2. Image

SetaPDF_Core_Image Base class for image handling

File: /SetaPDF v2/Core/Image.php

This class is responsible for getting the correct image type implementation for a desired image type.

Actually PNG and JPEG classes exist.

Class hierarchy

SetaPDF_Core_Image

Summary

Constants

TYPE_GIF

public const string SetaPDF_Core_Image::TYPE_GIF = 'gif'

Image type

TYPE_JPEG

public const string SetaPDF_Core_Image::TYPE_JPEG = 'jpeg'

Image type

TYPE_JPEG2000

public const string SetaPDF_Core_Image::TYPE_JPEG2000 = 'jpeg2000'

Image type

TYPE_PNG

public const string SetaPDF_Core_Image::TYPE_PNG = 'png'

Image type

TYPE_TIFF

public const string SetaPDF_Core_Image::TYPE_TIFF = 'tiff'

Image type

TYPE_UNKNOWN

public const string SetaPDF_Core_Image::TYPE_UNKNOWN = 'unknown'

Image type

Properties

$_binaryReader

protected SetaPDF_Core_Reader_Binary SetaPDF_Core_Image::$_binaryReader

Binary Reader

$_bitsPerComponent

protected integer SetaPDF_Core_Image::$_bitsPerComponent = 8

Bits per component

$_colorSpace

protected integer SetaPDF_Core_Image::$_colorSpace = -1

The image type specific colorspace

$_dpiX

protected integer SetaPDF_Core_Image::$_dpiX = 0

Dots-per-inch in the X direction

$_dpiY

protected integer SetaPDF_Core_Image::$_dpiY = 0

Dots-per-inch in the Y direction

$_height

protected integer SetaPDF_Core_Image::$_height

The pixel height

$_inverted

protected boolean SetaPDF_Core_Image::$_inverted = false

Flag for color inversion

$_width

protected integer SetaPDF_Core_Image::$_width

The pixel width

Static Methods

get()

public static SetaPDF_Core_Image::get (

SetaPDF_Core_Reader_ReaderInterface $reader

): SetaPDF_Core_Image

Get an image by a reader.

Parameters

$reader : SetaPDF_Core_Reader_ReaderInterface: The reader instance

Exceptions

Throws SetaPDF_Exception_NotImplemented If the image type is not supported (supported types: JPEG, PNG, JPEG2000).

getByPath()

public static SetaPDF_Core_Image::getByPath (

string $path

): SetaPDF_Core_Image

Get an image by a path.

Parameters

$path : string: The path to the image

getType()

public static SetaPDF_Core_Image::getType (

SetaPDF_Core_Reader_ReaderInterface $reader

): string

Get an image type by a reader.

Parameters

$reader : SetaPDF_Core_Reader_ReaderInterface

Methods

__construct()

public SetaPDF_Core_Image::__construct (

[ SetaPDF_Core_Reader_ReaderInterface $reader = null ]

)

The constructor.

Parameters

$reader : SetaPDF_Core_Reader_ReaderInterface

_process()

abstract protected SetaPDF_Core_Image::_process (

void

): void

Processes the image data so all needed information is available.

getBitsPerComponent()

public SetaPDF_Core_Image::getBitsPerComponent (

void

): integer

Get the bits per component value.

getColorSpace()

public SetaPDF_Core_Image::getColorSpace (

void

): number

Get the image type specific colorspace.

getDpiX()

public SetaPDF_Core_Image::getDpiX (

void

): number

Get the dots-per-inch in the X direction.

getDpiY()

public SetaPDF_Core_Image::getDpiY (

void

): number

Get the dots-per-inch in the Y direction.

getHeight()

public SetaPDF_Core_Image::getHeight (

[ float $width = null ]

): number

Get the height.

Parameters

$width : float: Value for keeping the aspect ratio

getWidth()

public SetaPDF_Core_Image::getWidth (

[ float $height = null ]

): number

Get the width.

Parameters

$height : float: Value for keeping the aspect ratio

toXObject()

abstract public SetaPDF_Core_Image::toXObject (

SetaPDF_Core_Document $document

): SetaPDF_Core_XObject_Image

Converts an image to an external object.

Parameters

$document : SetaPDF_Core_Document