Mike42\Escpos\ImagickEscposImage Class Reference

Implementation of EscposImage using the Imagick PHP plugin. More...

Inheritance diagram for Mike42\Escpos\ImagickEscposImage:

Collaboration diagram for Mike42\Escpos\ImagickEscposImage:

Public Member Functions
	readImageFromImagick (Imagick $im)
	Load actual image pixels from Imagick object. More...
Public Member Functions inherited from Mike42\Escpos\EscposImage
	__construct ($filename=null, $allowOptimisations=true)
	Construct a new EscposImage. More...
	getHeight ()
	getHeightBytes ()
	getWidth ()
	getWidthBytes ()
	toRasterFormat ()
	Output the image in raster (row) format. More...
	toColumnFormat ($doubleDensity=false)
	Output the image in column format. More...

Static Public Member Functions
static	loadPdf ($pdfFile, int $pageWidth=550)
	Load a PDF for use on the printer. More...
Static Public Member Functions inherited from Mike42\Escpos\EscposImage
static	isGdLoaded ()
static	isImagickLoaded ()
static	load (string $filename, bool $allowOptimisations=true, array $preferred=['imagick', 'gd', 'native'])
	This is a convinience method to load an image from file, auto-selecting an EscposImage implementation which uses an available library. More...

Protected Member Functions
	getColumnFormatFromFile ($filename=null, $highDensityVertical=true)
	loadImageData (string $filename=null)
	Load an image from disk, into memory, using Imagick. More...
	getRasterFormatFromFile ($filename=null)
Protected Member Functions inherited from Mike42\Escpos\EscposImage
	loadImageData (string $filename=null)
	Load an image from disk. More...
	setImgData ($data)
	Set image data. More...
	setImgWidth ($width)
	Set image width. More...
	setImgHeight ($height)
	Set image height. More...
	getRasterFormatFromFile ($filename=null)
	getColumnFormatFromFile ($filename=null, $highDensityVertical=true)

Additional Inherited Members
Protected Attributes inherited from Mike42\Escpos\EscposImage
	$imgHeight = 0
	height of the image.
	$imgWidth = 0
	width of the image

Detailed Description

Implementation of EscposImage using the Imagick PHP plugin.

Member Function Documentation

getColumnFormatFromFile()

Mike42\Escpos\ImagickEscposImage::getColumnFormatFromFile (   $filename = null,   $highDensityVertical = true  )

protected

Parameters

string	$filename	Filename to load from
boolean	$highDensityVertical	True for high density output (24px lines), false for regular density (8px)

Returns

string[]|NULL Column format data as array, or NULL if optimised renderer isn't available in this implementation.

getRasterFormatFromFile()

Mike42\Escpos\ImagickEscposImage::getRasterFormatFromFile (   $filename = null )

protected

Parameters

string

$filename

Filename to load from

Returns

string|NULL Raster format data, or NULL if no optimised renderer is available in this implementation.

loadImageData()

Mike42\Escpos\ImagickEscposImage::loadImageData ( string  $filename = null )

protected

Load an image from disk, into memory, using Imagick.

Parameters

string | null

$filename

The filename to load from

Exceptions

Exception

if the image format is not supported, or the file cannot be opened.

loadPdf()

static Mike42\Escpos\ImagickEscposImage::loadPdf (   $pdfFile, int  $pageWidth = 550  )

static

Load a PDF for use on the printer.

Parameters

string	$pdfFile	The file to load
int	$pageWidth	The width, in pixels, of the printer's output. The first page of the PDF will be scaled to approximately fit in this area.

Exceptions

Exception

Where Imagick is not loaded, or where a missing file or invalid page number is requested.

Returns

array Array of images, retrieved from the PDF file.

readImageFromImagick()

Mike42\Escpos\ImagickEscposImage::readImageFromImagick

(

Imagick

$im

)

Load actual image pixels from Imagick object.

Parameters

Imagick

$im

Image to load from

---

The documentation for this class was generated from the following file:

• src/Mike42/Escpos/ImagickEscposImage.php