\CodeIgniter\Images\HandlersBaseHandler

Base image handling implementation

Summary

Methods

Properties

Constants

__construct()
withFile()
getFile()
getResource()
resize()
crop()
convert()
rotate()
flatten()
flip()
text()
reorient()
getEXIF()
fit()
getVersion()
save()
__call()
getWidth()
getHeight()

No public properties found

No constants found

ensureResource()
_rotate()
_flip()
_text()
calcAspectRatio()
calcCropCoords()
process()
reproportion()

$config
$image
$width
$height
$filePermissions
$xAxis
$yAxis
$masterDim
$textDefaults
$resource

N/A

No private methods found

No private properties found

N/A

abstract

File: src/System/Images/Handlers/BaseHandler.php
Package: CodeIgniter
Class hierarchy: \CodeIgniter\Images\Handlers\BaseHandler
Implements: \CodeIgniter\Images\ImageHandlerInterface

Properties

$config

$config : \Config\Images

Configuration settings.

Type

\Config\Images

$image

$image : \CodeIgniter\Images\Image

The image/file instance

Type

\CodeIgniter\Images\Image

$width

$width : integer

Image width.

Type

integer

$height

$height : integer

Image height.

Type

integer

$filePermissions

$filePermissions : \CodeIgniter\Images\Handlers\type

File permission mask.

Type

\CodeIgniter\Images\Handlers\type

$xAxis

$xAxis : integer

X-axis.

Type

integer

$yAxis

$yAxis : integer

Y-axis.

Type

integer

$masterDim

$masterDim : string

Master dimensioning.

Type

string

$textDefaults

$textDefaults : array

Default options for text watermarking.

Type

array

$resource

$resource : resource

Temporary image used by the different engines.

Type

resource

Methods

__construct()

__construct(\CodeIgniter\Images\Handlers\type  $config = null)

Constructor.

Parameters

\CodeIgniter\Images\Handlers\type

$config

withFile()

withFile(string  $path) : $this

Sets another image for this handler to work on.

Keeps us from needing to continually instantiate the handler.

Parameters

string

$path

Returns

$this

getFile()

getFile() : \CodeIgniter\Images\Image

Returns the image instance.

Returns

\CodeIgniter\Images\Image

getResource()

getResource() : resource

Returns the temporary image used during the image processing.

Good for extending the system or doing things this library is not intended to do.

Returns

resource

resize()

resize(integer  $width, integer  $height, boolean  $maintainRatio = false, string  $masterDim = 'auto') : \CodeIgniter\Images\Handlers\BaseHandler

Resize the image

Parameters

integer	$width
integer	$height
boolean	$maintainRatio	If true, will get the closest match possible while keeping aspect ratio true.
string	$masterDim

Returns

\CodeIgniter\Images\Handlers\BaseHandler

crop()

crop(integer|null  $width = null, integer|null  $height = null, integer|null  $x = null, integer|null  $y = null, boolean  $maintainRatio = false, string  $masterDim = 'auto') : mixed

Crops the image to the desired height and width. If one of the height/width values is not provided, that value will be set the appropriate value based on offsets and image dimensions.

Parameters

integer\|null	$width
integer\|null	$height
integer\|null	$x	X-axis coord to start cropping from the left of image
integer\|null	$y	Y-axis coord to start cropping from the top of image
boolean	$maintainRatio
string	$masterDim

Returns

mixed

convert()

convert(integer|null  $imageType) : $this

Changes the stored image type to indicate the new file format to use when saving.

Does not touch the actual resource.

Parameters

integer|null

$imageType

A PHP imageType constant, e.g. https://www.php.net/manual/en/function.image-type-to-mime-type.php

Returns

$this

rotate()

rotate(float  $angle) : mixed

Rotates the image on the current canvas.

Parameters

float

$angle

Returns

mixed

flatten()

flatten(integer  $red = 255, integer  $green = 255, integer  $blue = 255) : mixed

Flattens transparencies, default white background

Parameters

integer	$red
integer	$green
integer	$blue

Returns

mixed

flip()

flip(string  $dir = 'vertical') : $this

Flips an image either horizontally or vertically.

Parameters

string

$dir

Either 'vertical' or 'horizontal'

Returns

$this

text()

text(string  $text, array  $options = array()) : $this

Overlays a string of text over the image.

Valid options:

color Text Color (hex number)
shadowColor Color of the shadow (hex number)
hAlign Horizontal alignment: left, center, right
vAlign Vertical alignment: top, middle, bottom
hOffset
vOffset
fontPath
fontSize
shadowOffset

Parameters

string	$text
array	$options

Returns

$this

reorient()

reorient(boolean  $silent = false) : $this

Reads the EXIF information from the image and modifies the orientation so that displays correctly in the browser. This is especially an issue with images taken by smartphones who always store the image up-right, but set the orientation flag to display it correctly.

Parameters

boolean

$silent

If true, will ignore exceptions when PHP doesn't support EXIF.

Returns

$this

getEXIF()

getEXIF(string|null  $key = null, boolean  $silent = false) : mixed

Retrieve the EXIF information from the image, if possible. Returns an array of the information, or null if nothing can be found.

EXIF data is only supported fr JPEG & TIFF formats.

Parameters

string\|null	$key	If specified, will only return this piece of EXIF data.
boolean	$silent	If true, will not throw our own exceptions.

Returns

mixed

fit()

fit(integer  $width, integer  $height = null, string  $position = 'center') : boolean

Combine cropping and resizing into a single command.

Supported positions:

top-left
top
top-right
left
center
right
bottom-left
bottom
bottom-right

Parameters

integer	$width
integer	$height
string	$position

Returns

boolean

getVersion()

getVersion() : string

Get the version of the image library in use.

Returns

string

save()

save(string  $target = null, integer  $quality = 90) : mixed

Saves any changes that have been made to file.

Example: $image->resize(100, 200, true) ->save($target);

Parameters

string	$target
integer	$quality

Returns

mixed

__call()

__call(string  $name, array  $args = array()) : mixed

Provide access to the Image class' methods if they don't exist on the handler itself.

Parameters

string	$name
array	$args

Returns

mixed

getWidth()

getWidth() : integer

Return image width.

accessor for testing; not part of interface

Returns

integer

getHeight()

getHeight() : \CodeIgniter\Images\Handlers\type

Return image height.

accessor for testing; not part of interface

Returns

\CodeIgniter\Images\Handlers\type

ensureResource()

ensureResource()

Make the image resource object if needed

_rotate()

_rotate(integer  $angle) : mixed

Handler-specific method to handle rotating an image in 90 degree increments.

Parameters

integer

$angle

Returns

mixed

_flip()

_flip(string  $direction) : mixed

Handler-specific method to handle flipping an image along its horizontal or vertical axis.

Parameters

string

$direction

Returns

mixed

_text()

_text(string  $text, array  $options = array())

Handler-specific method for overlaying text on an image.

Parameters

string	$text
array	$options

calcAspectRatio()

calcAspectRatio(  $width, null  $height = null,   $origWidth,   $origHeight) : array

Calculate image aspect ratio.

Parameters

	$width
null	$height
	$origWidth
	$origHeight

Returns

array

calcCropCoords()

calcCropCoords(  $width,   $height,   $origWidth,   $origHeight,   $position) : array

Based on the position, will determine the correct x/y coords to crop the desired portion from the image.

Parameters

	$width
	$height
	$origWidth
	$origHeight
	$position

Returns

array

process()

process(string  $action) : mixed

Does the driver-specific processing of the image.

Parameters

string

$action

Returns

mixed

reproportion()

reproportion() : void

Re-proportion Image Width/Height

When creating thumbs, the desired width/height can end up warping the image due to an incorrect ratio between the full-sized image and the thumb.

This function lets us re-proportion the width/height if users choose to maintain the aspect ratio when resizing.