ImageSizerEngine class

Located in file /wire/core/ImageSizerEngine.php

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

Show class?             Show args?        

Common

NameReturnSummary 
ImageSizerEngine::autoRotation bool 
ImageSizerEngine::avifAdd bool 
ImageSizerEngine::avifOnly bool null 
ImageSizerEngine::avifQuality int 
ImageSizerEngine::avifResult bool null 
ImageSizerEngine::convertToGreyscale()
boolConvert image to greyscale 
ImageSizerEngine::convertToSepia()
boolConvert image to sepia 
ImageSizerEngine::cropping array string bool 
ImageSizerEngine::croppingValue($cropping)
string bool arrayGiven an unknown cropping value, return the validated internal representation of it 
ImageSizerEngine::croppingValueStr($cropping)
stringGiven an unknown cropping value, return the string representation of it 
ImageSizerEngine::defaultGamma float 
ImageSizerEngine::enginePriority int Priority for use among other ImageSizerEngine modules (0=disabled, 1=first, 2=second, 3=and so on) 
ImageSizerEngine::flip string 
ImageSizerEngine::flipBoth()
boolFlip both vertically and horizontally 
ImageSizerEngine::flipHorizontal()
boolFlip horizontally 
ImageSizerEngine::flipVertical()
boolFlip vertically 
ImageSizerEngine::get(string $key)
mixed nullGet a property 
ImageSizerEngine::getConfigData()
arrayGet module config data 
ImageSizerEngine::getEngineInfo()
arrayGet array of information about this engine 
ImageSizerEngine::getExtension()
stringReturn the file extension 
ImageSizerEngine::getFilename()
stringReturn the filename 
ImageSizerEngine::getHeight()
intReturn the image height 
ImageSizerEngine::getImageType()
string nullReturn the image type constant 
ImageSizerEngine::getLibraryVersion()
stringGet library version string 
ImageSizerEngine::getModified()
boolGet whether the image was modified 
ImageSizerEngine::getModuleConfigInputfields(InputfieldWrapper $inputfields)
(nothing)Module configuration 
ImageSizerEngine::getOptions()
arrayReturn an array of the current options 
ImageSizerEngine::getSupportedFormats()
arrayGet an array of image file formats this ImageSizerModule can use as source or target 
ImageSizerEngine::getWidth()
intReturn the image width 
ImageSizerEngine::interlace bool 
ImageSizerEngine::isAutoload()
boolModule info: not-autoload 
ImageSizerEngine::isModified()
boolWas the image modified? 
ImageSizerEngine::isSingular()
boolModule info: not singular 
ImageSizerEngine::prepare(string $filename)
(nothing)Prepare the ImageSizer (this should be the first method you call) 
ImageSizerEngine::quality int 
ImageSizerEngine::resize(int $finalWidth, int $finalHeight)
boolResize the image 
ImageSizerEngine::rotate(int $degrees)
boolJust rotate image by number of degrees
Can also be used as property: ImageSizerEngine::rotate
 
ImageSizerEngine::scale float 
ImageSizerEngine::setAutoRotation()
selfTurn on/off auto rotation 
ImageSizerEngine::setAvifAdd($avifAdd)
(nothing) 
ImageSizerEngine::setAvifOnly($value)
(nothing) 
ImageSizerEngine::setAvifQuality($n)
(nothing) 
ImageSizerEngine::setConfigData(array $data)
(nothing)Set module config data for ConfigurableModule interface 
ImageSizerEngine::setCropExtra(array $value)
selfSet values for cropExtra rectangle, which enables cropping before resizing 
ImageSizerEngine::setCropping()
selfTurn on/off cropping and/or set cropping direction 
ImageSizerEngine::setDefaultGamma()
selfSet default gamma value: 0.5 - 4.0 | -1 
ImageSizerEngine::setFlip($flip)
selfSet flip 
ImageSizerEngine::setHidpi()
selfEnable hidpi mode? 
ImageSizerEngine::setInterlace()
selfTurn on/off interlace 
ImageSizerEngine::setModified(bool $modified)
selfSet whether the image was modified 
ImageSizerEngine::setOptions(array $options)
selfAlternative to the above set* functions where you specify all in an array 
ImageSizerEngine::setQuality(int $n)
selfSet the image quality 1-100, where 100 is highest quality 
ImageSizerEngine::setRotate($degrees)
selfSet rotation degrees 
ImageSizerEngine::setScale(float $scale)
selfSet scale for hidpi (2.0=hidpi, 1.0=normal, or other value if preferred) 
ImageSizerEngine::setSharpening(mixed $value)
selfSet sharpening value: blank (for none), soft, medium, or strong 
ImageSizerEngine::setTimeLimit()
selfSet a time limit for manipulating one image (default is 30) 
ImageSizerEngine::setUpscaling()
selfTurn on/off upscaling 
ImageSizerEngine::setUseUSM()
selfToggle on/off the usage of USM algorithm for sharpening 
ImageSizerEngine::setWebpAdd(bool $webpAdd)
selfSet flag to also create a webp file or not 
ImageSizerEngine::setWebpOnly($value)
selfSet flag to only create a webp file 
ImageSizerEngine::setWebpQuality(int $n)
selfSet the image quality 1-100 for WebP output, where 100 is highest quality 
ImageSizerEngine::sharpening string 
ImageSizerEngine::sharpeningValueStr($value)
stringGiven an unknown sharpening value, return the string representation of it 
ImageSizerEngine::supported()
boolIs this ImageSizer class ready only means: does the server / system provide all Requirements! 
ImageSizerEngine::upscaling bool 
ImageSizerEngine::useUSM bool 
ImageSizerEngine::webpAdd bool 
ImageSizerEngine::webpOnly bool null 
ImageSizerEngine::webpQuality int 
ImageSizerEngine::webpResult bool null 
ImageSizerEngine::writeBackIPTC(string $filename)
bool nullDefault IPTC Handling 

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #519
    In the 519th issue of ProcessWire Weekly we'll check out a new third party module called RockForms, introduce the latest ProcessWire core updates, and more. Read on!
    Weekly.pw / 20 April 2024
  • ProFields Table Field with Actions support
    This week we have some updates for the ProFields table field (FieldtypeTable). These updates are primarily focused on adding new tools for the editor to facilitate input and management of content in a table field.
    Blog / 12 April 2024
  • Subscribe to weekly ProcessWire news

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani