ImageSizer class

ImageSizer handles resizing of a single JPG, GIF, or PNG image using GD2

or another supported and configured engine. (Imagick, ImageMagick, Netpbm)

Code for IPTC, auto rotation and sharpening by Horst Nogajski.

Other user contributions as noted.

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the ImageSizer class also inherits all the methods and properties of: Wire.

Common

Name	Return	Summary
ImageSizer::convertToGreyscale() ImageSizer::convertToGreyscale() ImageSizer::convertToGreyscale()	`bool`	Convert image to greyscale (black and white)
ImageSizer::convertToSepia() ImageSizer::convertToSepia() ImageSizer::convertToSepia(int $sepia = 55)	`bool`	Convert image to sepia tone
ImageSizer::croppingValue() ImageSizer::croppingValue($cropping) ImageSizer::croppingValue($cropping)	`string` `bool`	Given an unknown cropping value, return the validated internal representation of it
ImageSizer::croppingValueStr() ImageSizer::croppingValueStr($cropping) ImageSizer::croppingValueStr($cropping)	`string`	Given an unknown cropping value, return the string representation of it
ImageSizer::flipBoth() ImageSizer::flipBoth() ImageSizer::flipBoth()	`bool`	Flip both vertically and horizontally
ImageSizer::flipHorizontal() ImageSizer::flipHorizontal() ImageSizer::flipHorizontal()	`bool`	Flip image horizontally
ImageSizer::flipVertical() ImageSizer::flipVertical() ImageSizer::flipVertical()	`bool`	Flip image vertically
ImageSizer::getEngine() ImageSizer::getEngine() ImageSizer::getEngine(string $engineName = '')	`ImageSizerEngine` `null`	Get the current ImageSizerEngine
ImageSizer::getEngineInfo() ImageSizer::getEngineInfo() ImageSizer::getEngineInfo(string $name = '')	`array`	Get array of information for all ImageSizer engines (or optionally a specific ImageSizer engine)
ImageSizer::getEngines() ImageSizer::getEngines() ImageSizer::getEngines(bool $forceReload = false)	`array`	Get array of all available ImageSizer engine names in order of priority
ImageSizer::getExtension() ImageSizer::getExtension() ImageSizer::getExtension()	None
ImageSizer::getFailedEngineNames() ImageSizer::getFailedEngineNames() ImageSizer::getFailedEngineNames()	None
ImageSizer::getFilename() ImageSizer::getFilename() ImageSizer::getFilename()	None
ImageSizer::getHeight() ImageSizer::getHeight() ImageSizer::getHeight()	None
ImageSizer::getImageInfo() ImageSizer::getImageInfo() ImageSizer::getImageInfo(bool $rawData = false)	`string` `array`	ImageInformation from Image Inspector in short form or full RawInfoData
ImageSizer::getImageType() ImageSizer::getImageType() ImageSizer::getImageType()	None
ImageSizer::getOptions() ImageSizer::getOptions() ImageSizer::getOptions()	None
ImageSizer::getWidth() ImageSizer::getWidth() ImageSizer::getWidth()	None
ImageSizer::imageIsAnimatedGif() ImageSizer::imageIsAnimatedGif(mixed $image) ImageSizer::imageIsAnimatedGif(mixed $image)	`bool` `null`	Check if GIF-image is animated or not (
ImageSizer::imageIsRotated() ImageSizer::imageIsRotated(mixed $image) ImageSizer::imageIsRotated(mixed $image, mixed $correctionArray = null)	`bool` `null`	Check orientation (
ImageSizer::imageResetIPTC() ImageSizer::imageResetIPTC(mixed $image) ImageSizer::imageResetIPTC(mixed $image)	`null` `bool`	Possibility to clean IPTC data, also for original images (
ImageSizer::isModified() ImageSizer::isModified() ImageSizer::isModified()	None
ImageSizer::resize() ImageSizer::resize(int $targetWidth) ImageSizer::resize(int $targetWidth, int $targetHeight = 0)	`bool`	Resize the image proportionally to the given width/height
ImageSizer::rotate() ImageSizer::rotate(int $degrees) ImageSizer::rotate(int $degrees)	`bool`	Rotate image by given degrees
ImageSizer::setAutoRotation() ImageSizer::setAutoRotation() ImageSizer::setAutoRotation($value = true)	None
ImageSizer::setCropExtra() ImageSizer::setCropExtra($value) ImageSizer::setCropExtra($value)	None
ImageSizer::setCropping() ImageSizer::setCropping() ImageSizer::setCropping($cropping = true)	None
ImageSizer::setDefaultGamma() ImageSizer::setDefaultGamma() ImageSizer::setDefaultGamma($value = 2.2)	None
ImageSizer::setFilename() ImageSizer::setFilename($filename) ImageSizer::setFilename($filename)	`$this`	Set the filename
ImageSizer::setFlip() ImageSizer::setFlip($flip) ImageSizer::setFlip($flip)	None
ImageSizer::setForceEngine() ImageSizer::setForceEngine($engineName) ImageSizer::setForceEngine($engineName)	`$this`	Force the use of a specific engine
ImageSizer::setHidpi() ImageSizer::setHidpi() ImageSizer::setHidpi($hidpi = true)	None
ImageSizer::setModified() ImageSizer::setModified($modified) ImageSizer::setModified($modified)	`$this`	Set whether a modification was made
ImageSizer::setOptions() ImageSizer::setOptions(array $options) ImageSizer::setOptions(array $options)	`$this`	Set multiple resize options
ImageSizer::setQuality() ImageSizer::setQuality($n) ImageSizer::setQuality($n)	None
ImageSizer::setRotate() ImageSizer::setRotate($degrees) ImageSizer::setRotate($degrees)	None
ImageSizer::setScale() ImageSizer::setScale($scale) ImageSizer::setScale($scale)	None
ImageSizer::setSharpening() ImageSizer::setSharpening($value) ImageSizer::setSharpening($value)	None
ImageSizer::setTimeLimit() ImageSizer::setTimeLimit() ImageSizer::setTimeLimit($value = 30)	None
ImageSizer::setUpscaling() ImageSizer::setUpscaling() ImageSizer::setUpscaling($value = true)	None
ImageSizer::setUseUSM() ImageSizer::setUseUSM() ImageSizer::setUseUSM($value = true)	None
ImageSizer::sharpeningValueStr() ImageSizer::sharpeningValueStr($value) ImageSizer::sharpeningValueStr($value, bool $short = false)	`string`	Given an unknown sharpening value, return the string representation of it

Additional methods and properties

In addition to the methods and properties above, ImageSizer also inherits the methods and properties of these classes:

Wire

API reference based on ProcessWire core version 3.0.251