Joomla! API

Download
Launch

Image

Extends \Joomla\Image\Image

Class to manipulate an image.

since

1.7.3

Methods

__construct

Class constructor.

__construct(mixed $source = null)
since

1.0
throws

\RuntimeException

Arguments

$source

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

__destruct

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

__destruct()
see \Joomla\Image\Image::destroy()
since

1.0

createThumbs

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

createThumbs(mixed $thumbSizes, integer $creationMethod = self::SCALE_INSIDE, string $thumbsFolder = null) : array
since

1.0
throws

\LogicException

\InvalidArgumentException

Arguments

$thumbSizes

mixedstring or array of strings. Example: $thumbSizes = array('150x75','250x150');

$creationMethod

integer1-3 resize $scaleMethod | 4 create cropping

$thumbsFolder

stringdestination thumbs folder. null generates a thumbs folder in the image folder

Response

array

crop

Method to crop the current image.

crop(mixed $width, mixed $height, integer $left = null, integer $top = null, boolean $createNew = true) : \Joomla\Image\Image
since

1.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

integerThe number of pixels from the left to start cropping.

$top

integerThe number of pixels from the top to start cropping.

$createNew

booleanIf true the current image will be cloned, cropped and returned; else the current image will be cropped and returned.

Response

\Joomla\Image\Image

cropResize

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

cropResize(integer $width, integer $height, integer $createNew = true) : \Joomla\Image\Image
since

1.0

Arguments

$width

integerThe desired width of the image in pixels or a percentage.

$height

integerThe desired height of the image in pixels or a percentage.

$createNew

integerIf true the current image will be cloned, resized, cropped and returned.

Response

\Joomla\Image\Image

destroy

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

destroy() : boolean
since

1.0

Response

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

filter

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

filter(string $type, array $options = array()) : \Joomla\Image\Image
since

1.0
see \Joomla\Image\Joomla\Image\Filter
throws

\LogicException

Arguments

$type

stringThe name of the image filter to apply.

$options

arrayAn array of options for the filter.

Response

\Joomla\Image\Image

flip

Method to flip the current image.

flip(integer $mode, boolean $createNew = true) : \Joomla\Image\Image
since

1.2.0
throws

\LogicException

Arguments

$mode

integerThe flip mode for flipping the image {@link https://www.php.net/imageflip#refsect1-function.imageflip-parameters}

$createNew

booleanIf true the current image will be cloned, flipped and returned; else the current image will be flipped and returned.

Response

\Joomla\Image\Image

generateThumbs

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

generateThumbs(mixed $thumbSizes, integer $creationMethod = self::SCALE_INSIDE) : array
since

1.0
throws

\LogicException

\InvalidArgumentException

Arguments

$thumbSizes

mixedString or array of strings. Example: $thumbSizes = array('150x75','250x150');

$creationMethod

integer1-3 resize $scaleMethod | 4 create cropping | 5 resize then crop

Response

array

getFilterInstance

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

getFilterInstance(string $type) : \Joomla\Image\ImageFilter
since

1.0
throws

\RuntimeException

Arguments

$type

stringThe image filter type to get.

Response

\Joomla\Image\ImageFilter

getHandle

Get the image resource handle

getHandle() : resource
since

1.3.0
throws

\LogicExceptionif an image has not been loaded into the instance

Response

resource

getHeight

Method to get the height of the image in pixels.

getHeight() : integer
since

1.0
throws

\LogicException

Response

integer

getImageFileProperties

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

getImageFileProperties(string $path) : \stdClass
static

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

since

1.0
throws

\InvalidArgumentException

\RuntimeException

Arguments

$path

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

Response

\stdClass

getLogger

Get the logger.

getLogger() : \Psr\Log\LoggerInterface
since

1.0

Response

\Psr\Log\LoggerInterface

getOrientation

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

getOrientation() : mixed

The orientation will be returned as a string.

since

1.2.0

Response

mixedOrientation string or null.

getOrientationString

Compare width and height integers to determine image orientation.

getOrientationString(integer $width, integer $height) : string
static
since

1.2.0

Arguments

$width

integerThe width value to use for calculation

$height

integerThe height value to use for calculation

Response

stringOrientation string

getPath

Method to return the path

getPath() : string
since

1.0

Response

string

getWidth

Method to get the width of the image in pixels.

getWidth() : integer
since

1.0
throws

\LogicException

Response

integer

isLoaded

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

isLoaded() : boolean
since

1.0

Response

boolean

isTransparent

Method to determine whether or not the image has transparency.

isTransparent() : boolean
since

1.0
throws

\LogicException

Response

boolean

isValidImage

isValidImage(mixed $handle) : boolean

Arguments

$handle

mixedA potential image handle

Response

boolean

loadFile

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

loadFile(string $path) : void
since

1.0
throws

\InvalidArgumentException

\RuntimeException

Arguments

$path

stringThe filesystem path to load as an image.

prepareDimensions

Method to get the new dimensions for a resized image.

prepareDimensions(integer $width, integer $height, integer $scaleMethod) : \stdClass
since

1.0
throws

\InvalidArgumentExceptionIf width, height or both given as zero

Arguments

$width

integerThe width of the resized image in pixels.

$height

integerThe height of the resized image in pixels.

$scaleMethod

integerThe method to use for scaling

Response

\stdClass

resize

Method to resize the current image.

resize(mixed $width, mixed $height, boolean $createNew = true, integer $scaleMethod = self::SCALE_INSIDE) : \Joomla\Image\Image
since

1.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

booleanIf true the current image will be cloned, resized and returned; else the current image will be resized and returned.

$scaleMethod

integerWhich method to use for scaling

Response

\Joomla\Image\Image

rotate

Method to rotate the current image.

rotate(mixed $angle, integer $background = -1, boolean $createNew = true) : \Joomla\Image\Image
since

1.0
throws

\LogicException

Arguments

$angle

mixedThe angle of rotation for the image

$background

integerThe background color to use when areas are added due to rotation

$createNew

booleanIf true the current image will be cloned, rotated and returned; else the current image will be rotated and returned.

Response

\Joomla\Image\Image

sanitizeHeight

Method to sanitize a height value.

sanitizeHeight(mixed $height, mixed $width) : integer
since

1.0

Arguments

$height

mixedThe input height value to sanitize.

$width

mixedThe input width value for reference.

Response

integer

sanitizeOffset

Method to sanitize an offset value like left or top.

sanitizeOffset(mixed $offset) : integer
since

1.0

Arguments

$offset

mixedAn offset value.

Response

integer

sanitizeWidth

Method to sanitize a width value.

sanitizeWidth(mixed $width, mixed $height) : integer
since

1.0

Arguments

$width

mixedThe input width value to sanitize.

$height

mixedThe input height value for reference.

Response

integer

setLogger

Sets a logger instance on the object

setLogger(\Psr\Log\LoggerInterface $logger) : \Joomla\Image\Image
since

1.0

Arguments

$logger

\Psr\Log\LoggerInterfaceA PSR-3 compliant logger.

Response

\Joomla\Image\ImageThis object for message chaining.

setThumbnailGenerate

Method for set option of generate thumbnail method

setThumbnailGenerate(boolean $quality = true) : void
since

1.4.0

Arguments

$quality

booleanTrue for best quality. False for best speed.

toFile

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

toFile(mixed $path, integer $type = IMAGETYPE_JPEG, array $options = array()) : boolean
link

https://www.php.net/manual/image.constants.php
since

1.0
throws

\LogicException

Arguments

$path

mixedThe filesystem path to save the image. When null, the raw image stream will be outputted directly.

$type

integerThe image type to save the file as.

$options

arrayThe 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

boolean

watermark

Watermark the image

watermark(\Joomla\Image\Image $watermark, integer $transparency = 50, integer $bottomMargin, integer $rightMargin) : \Joomla\Image\Image
since

1.3.0
link

https://www.php.net/manual/en/image.examples-watermark.php

Arguments

$watermark

\Joomla\Image\ImageThe Image object containing the watermark graphic

$transparency

integerThe transparency to use for the watermark graphic

$bottomMargin

integerThe margin from the bottom of this image

$rightMargin

integerThe margin from the right side of this image

Response

\Joomla\Image\Image

Constants

SCALE_FILL

Value 1
const

integer
since

1.0

Type(s)

SCALE_INSIDE

Value 2
const

integer
since

1.0

Type(s)

SCALE_OUTSIDE

Value 3
const

integer
since

1.0

Type(s)

CROP

Value 4
const

integer
since

1.0

Type(s)

CROP_RESIZE

Value 5
const

integer
since

1.0

Type(s)

SCALE_FIT

Value 6
const

integer
since

1.0

Type(s)

ORIENTATION_LANDSCAPE

Value 'landscape'
const

string
since

1.2.0

Type(s)

ORIENTATION_PORTRAIT

Value 'portrait'
const

string
since

1.2.0

Type(s)

ORIENTATION_SQUARE

Value 'square'
const

string
since

1.2.0

Type(s)

Properties

handle

The image resource handle.

since

1.0

Type(s)

resource|\GdImage

path

The source image path.

since

1.0

Type(s)

string

formats

Whether or not different image formats are supported.

static
since

1.0

Type(s)

array

logger

Logger object

since

1.0

Type(s)

\Psr\Log\LoggerInterface

generateBestQuality

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

since

1.4.0

Type(s)

boolean
  • \ Joomla
  • \ CMS
  • \ Image
  • \ Image