Joomla! API

Class constructor.

__construct( source = null) :

since	1.7.3
throws	`RuntimeException`

Arguments

source: mixedEither a file path for a source image or a GD resource handler for an image.

Response

mixed

Method to call the destroy() method one last time to free any memory when the object is unset

__destruct() :

see	Image::destroy()
since	2.5.0

Response

mixed

Method to create thumbnails from the current image and save them to disk. It allows creation by resizing or cropping the original image.

createThumbnails( thumbSizes,  creationMethod = self::SCALE_INSIDE,  thumbsFolder = null,  useOriginalName = false) : mixed||string|int

since

since	4.3.0
throws	`LogicException` `InvalidArgumentException`

4.3.0

throws

LogicException

InvalidArgumentException

Arguments

thumbSizes: mixedstring or array of strings. Example: $thumbSizes = ['150x75','250x150'];
creationMethod: int1-3 resize $scaleMethod | 4 create cropping
thumbsFolder: stringdestination thumbs folder. null generates a thumbs folder in the image folder
useOriginalName: boolShall we use the original image name? Defaults is false, {filename}_{width}x{height}.{ext}

Response

array<string|int, mixed>

Method to create thumbnails from the current image and save them to disk. It allows creation by resizing or cropping the original image.

createThumbs( thumbSizes,  creationMethod = self::SCALE_INSIDE,  thumbsFolder = null) : mixed||string|int

deprecated

since

2.5.0

throws

LogicException

InvalidArgumentException

deprecated

4.0 will be removed in 6.0 Use \Joomla\CMS\Image\createThumbnails instead

Arguments

thumbSizes: mixedstring or array of strings. Example: $thumbSizes = ['150x75','250x150'];
creationMethod: int1-3 resize $scaleMethod | 4 create cropping
thumbsFolder: stringdestination thumbs folder. null generates a thumbs folder in the image folder

Response

array<string|int, mixed>

Method to crop the current image.

crop( width,  height,  left = null,  top = null,  createNew = true) : \Joomla\CMS\Image\Image

since	2.5.0
throws	`LogicException`

Arguments

width: mixedThe width of the image section to crop in pixels or a percentage.
height: mixedThe height of the image section to crop in pixels or a percentage.
left: intThe number of pixels from the left to start cropping.
top: intThe number of pixels from the top to start cropping.
createNew: boolIf true the current image will be cloned, cropped and returned; else the current image will be cropped and returned.

Response

Image

Method to crop an image after resizing it to maintain proportions without having to do all the set up work.

cropResize( width,  height,  createNew = true) : \Joomla\CMS\Image\Image

since	2.5.0

Arguments

width: intThe desired width of the image in pixels or a percentage.
height: intThe desired height of the image in pixels or a percentage.
createNew: boolIf true the current image will be cloned, resized, cropped and returned.

Response

Image

Method to destroy an image handle and free the memory associated with the handle

destroy() :

since	2.5.0

Response

boolTrue on success, false on failure or if no image is loaded

Method to apply a filter to the image by type. Two examples are: grayscale and sketchy.

filter( type, mixed||string|int options = []) : \Joomla\CMS\Image\Image

since	2.5.0
see	Filter
throws	`LogicException`

Arguments

type: stringThe name of the image filter to apply.
options: array<string|int, mixed>An array of options for the filter.

Response

Image

Method to flip the current image.

flip( mode,  createNew = true) : \Joomla\CMS\Image\Image

since	3.4.2
throws	`LogicException`

Arguments

mode: intThe flip mode for flipping the image {@link http://php.net/imageflip#refsect1-function.imageflip-parameters}
createNew: boolIf true the current image will be cloned, flipped and returned; else the current image will be flipped and returned.

Response

Image

Method to generate thumbnails from the current image. It allows creation by resizing or cropping the original image.

generateThumbs( thumbSizes,  creationMethod = self::SCALE_INSIDE) : mixed||string|int

since

2.5.0

throws

LogicException

InvalidArgumentException

Arguments

thumbSizes: mixedString or array of strings. Example: $thumbSizes = array('150x75','250x150');
creationMethod: int1-3 resize $scaleMethod | 4 create cropping | 5 resize then crop

Response

array<string|int, mixed>

Method to get an image filter instance of a specified type.

getFilterInstance( type) : \Joomla\CMS\Image\ImageFilter

since	2.5.0
throws	`RuntimeException`

Arguments

type: stringThe image filter type to get.

Response

ImageFilter

Get the image resource handle

getHandle() :

since	3.8.0
throws	`LogicException`if an image has not been loaded into the instance

Response

resource

Method to get the height of the image in pixels.

getHeight() :

since	2.5.0
throws	`LogicException`

Response

int

Method to return a properties object for an image given a filesystem path.

getImageFileProperties( path) : \stdClass

static

The result object has values for image width, height, type, attributes, mime type, bits, and channels.

since

2.5.0

throws

InvalidArgumentException

RuntimeException

Arguments

path: stringThe filesystem path to the image for which to get properties.

Response

stdClass

Method to detect whether an image's orientation is landscape, portrait or square.

getOrientation() :

The orientation will be returned as a string.

since	3.4.2

Response

mixedOrientation string or null.

Compare width and height integers to determine image orientation.

getOrientationString( width,  height) :

static

since	3.4.2

Arguments

width: intThe width value to use for calculation
height: intThe height value to use for calculation

Response

stringOrientation string

Method to return the path

getPath() :

since	2.5.0

Response

string

Method to get the width of the image in pixels.

getWidth() :

since	2.5.0
throws	`LogicException`

Response

int

Method to determine whether or not an image has been loaded into the object.

isLoaded() :

since	2.5.0

Response

bool

Method to determine whether or not the image has transparency.

isTransparent() :

since	2.5.0
throws	`LogicException`

Response

bool

Method to load a file into the Image object as the resource.

loadFile( path) :

since

2.5.0

throws

InvalidArgumentException

RuntimeException

Arguments

path: stringThe filesystem path to load as an image.

Response

void

Method to get the new dimensions for a resized image.

prepareDimensions( width,  height,  scaleMethod) : \stdClass

since	2.5.0
throws	`InvalidArgumentException`If width, height or both given as zero

Arguments

width: intThe width of the resized image in pixels.
height: intThe height of the resized image in pixels.
scaleMethod: intThe method to use for scaling

Response

stdClass

Method to resize the current image.

resize( width,  height,  createNew = true,  scaleMethod = self::SCALE_INSIDE) : \Joomla\CMS\Image\Image

since	2.5.0
throws	`LogicException`

Arguments

width: mixedThe width of the resized image in pixels or a percentage.
height: mixedThe height of the resized image in pixels or a percentage.
createNew: boolIf true the current image will be cloned, resized and returned; else the current image will be resized and returned.
scaleMethod: intWhich method to use for scaling

Response

Image

Method to rotate the current image.

rotate( angle,  background = -1,  createNew = true) : \Joomla\CMS\Image\Image

since	2.5.0
throws	`LogicException`

Arguments

angle: mixedThe angle of rotation for the image
background: intThe background color to use when areas are added due to rotation
createNew: boolIf true the current image will be cloned, rotated and returned; else the current image will be rotated and returned.

Response

Image

Method to sanitize a height value.

sanitizeHeight( height,  width) :

since	2.5.0

Arguments

height: mixedThe input height value to sanitize.
width: mixedThe input width value for reference.

Response

int

Method to sanitize an offset value like left or top.

sanitizeOffset( offset) :

since	2.5.0

Arguments

offset: mixedAn offset value.

Response

int

Method to sanitize a width value.

sanitizeWidth( width,  height) :

since	2.5.0

Arguments

width: mixedThe input width value to sanitize.
height: mixedThe input height value for reference.

Response

int

Method for set option of generate thumbnail method

setThumbnailGenerate( quality = true) :

since	3.7.0

Arguments

quality: boolTrue for best quality. False for best speed.

Response

void

Method to write the current image out to a file or output directly.

toFile( path,  type = IMAGETYPE_JPEG, mixed||string|int options = []) :

link
since	2.5.0
throws	`LogicException`

Arguments

path: mixedThe filesystem path to save the image. When null, the raw image stream will be outputted directly.
type: intThe image type to save the file as.
options: array<string|int, mixed>The image type options to use in saving the file. For PNG and JPEG formats use quality key to set compression level (0..9 and 0..100)

Response

bool

Watermark the image

watermark(\Joomla\CMS\Image\Image watermark,  transparency = 50,  bottomMargin,  rightMargin) : \Joomla\CMS\Image\Image

since	3.8.0
link

Arguments

watermark: ImageThe Image object containing the watermark graphic
transparency: intThe transparency to use for the watermark graphic
bottomMargin: intThe margin from the bottom of this image
rightMargin: intThe margin from the right side of this image

Response

Image

Value	1
const	integer
since	2.5.0

Value	2
const	integer
since	2.5.0

Value	3
const	integer
since	2.5.0

Value	4
const	integer
since	2.5.0

Value	5
const	integer
since	2.5.0

Value	6
const	integer
since	2.5.0

Value	'landscape'
const	string
since	3.4.2

Value	'portrait'
const	string
since	3.4.2

Value	'square'
const	string
since	3.4.2

The image resource handle.

since	2.5.0

Type(s)

resource

The source image path.

since	2.5.0

Type(s)

string

Whether or not different image formats are supported.

static

since	2.5.0

Type(s)

array<string|int, mixed>

Flag if an image should use the best quality available. Disable for improved performance.

since	3.7.0

Type(s)

bool

since	1.7.3
package	Joomla CMS

Image

Methods

__construct

Arguments

Response

__destruct

Response

createThumbnails

Arguments

Response

createThumbs

Arguments

Response

crop

Arguments

Response

cropResize

Arguments

Response

destroy

Response

filter

Arguments

Response

flip

Arguments

Response

generateThumbs

Arguments

Response

getFilterInstance

Arguments

Response

getHandle

Response

getHeight

Response

getImageFileProperties

Arguments

Response

getOrientation

Response

getOrientationString

Arguments

Response

getPath

Response

getWidth

Response

isLoaded

Response

isTransparent

Response

loadFile

Arguments

Response

prepareDimensions

Arguments

Response

resize

Arguments

Response

rotate

Arguments

Response

sanitizeHeight

Arguments

Response

sanitizeOffset

Arguments

Response

sanitizeWidth

Arguments

Response

setThumbnailGenerate

Arguments

Response

toFile

Arguments

Response