Abstract Class setasign\SetaPDF2\Core\Image\Image in SetaPDF v2 API Reference

Index

\setasign\SetaPDF2
1. Core
  1. Image
    1. Exception
    2. Gif
    3. Gif
    4. Image
    5. Jpeg
    6. Jpeg2000
    7. Png

setasign\SetaPDF2\Core\Image

Image Base class for image handling

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

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

Actually PNG and JPEG classes exist.

Class hierarchy

Image

Summary

Constants

TYPE_GIF

public const string Image::TYPE_GIF = 'gif'

Image type

TYPE_JPEG

public const string Image::TYPE_JPEG = 'jpeg'

Image type

TYPE_JPEG2000

public const string Image::TYPE_JPEG2000 = 'jpeg2000'

Image type

TYPE_PNG

public const string Image::TYPE_PNG = 'png'

Image type

TYPE_TIFF

public const string Image::TYPE_TIFF = 'tiff'

Image type

TYPE_UNKNOWN

public const string Image::TYPE_UNKNOWN = 'unknown'

Image type

Properties

$_binaryReader

protected \SetaPDF_Core_Reader_Binary Image::$_binaryReader

Binary Reader

$_bitsPerComponent

protected int Image::$_bitsPerComponent = 8

Bits per component

$_colorSpace

protected int Image::$_colorSpace = -1

The image type specific colorspace

$_dpiX

protected int Image::$_dpiX = 0

Dots-per-inch in the X direction

$_dpiY

protected int Image::$_dpiY = 0

Dots-per-inch in the Y direction

$_height

protected int Image::$_height

The pixel height

$_inverted

protected bool Image::$_inverted = false

Flag for color inversion

$_width

protected int Image::$_width

The pixel width

Static Methods

get()

public static 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 \setasign\SetaPDF2\NotImplementedException If the image type is not supported (supported types: JPEG, PNG, JPEG2000).

getByPath()

public static Image::getByPath (

string $path

): \SetaPDF_Core_Image

Get an image by a path.

Parameters

$path : string: The path to the image

getType()

public static Image::getType (

\SetaPDF_Core_Reader_ReaderInterface $reader

): string

Get an image type by a reader.

Parameters

$reader : \SetaPDF_Core_Reader_ReaderInterface

Methods

__construct()

public Image::__construct (

?\SetaPDF_Core_Reader_ReaderInterface $reader = null

)

The constructor.

Parameters

$reader : ?\SetaPDF_Core_Reader_ReaderInterface

_process()

abstract protected Image::_process (

void

): void

Processes the image data so all needed information is available.

getBitsPerComponent()

public Image::getBitsPerComponent (

void

): int

Get the bits per component value.

getColorSpace()

public Image::getColorSpace (

void

): number

Get the image type specific colorspace.

getDpiX()

public Image::getDpiX (

void

): number

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

getDpiY()

public Image::getDpiY (

void

): number

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

getHeight()

public Image::getHeight (

float $width = null

): number

Get the height.

Parameters

$width : float: Value for keeping the aspect ratio

getWidth()

public Image::getWidth (

float $height = null

): number

Get the width.

Parameters

$height : float: Value for keeping the aspect ratio

toXObject()

abstract public Image::toXObject (

\SetaPDF_Core_Document $document

): \SetaPDF_Core_XObject_Image

Converts an image to an external object.

Parameters

$document : \SetaPDF_Core_Document