Image

Type
Abstract Class
Namespace
craft\base
Inherits
craft\base\Image » yii\base\BaseObject (opens new window)
Implements
yii\base\Configurable (opens new window)
Extended by
craft\image\Raster, craft\image\Svg
Since
3.0.0

Base Image class.

View source (opens new window)

# Public Properties

# extension

Type
string (opens new window)
Default value
null
Access
Read-only

View source (opens new window)

# height

Type
integer (opens new window)
Default value
null
Access
Read-only

View source (opens new window)

# isTransparent

Type
boolean (opens new window)
Default value
null
Access
Read-only

View source (opens new window)

# width

Type
integer (opens new window)
Default value
null
Access
Read-only

View source (opens new window)

# Public Methods

Method Description
__call() (opens new window) Calls the named method which is not a class method.
__construct() (opens new window) Constructor.
__get() (opens new window) Returns the value of an object property.
__isset() (opens new window) Checks if a property is set, i.e. defined and not null.
__set() (opens new window) Sets value of an object property.
__unset() (opens new window) Sets an object property to null.
canGetProperty() (opens new window) Returns a value indicating whether a property can be read.
canSetProperty() (opens new window) Returns a value indicating whether a property can be set.
className() (opens new window) Returns the fully qualified name of this class.
crop() Crops the image to the specified coordinates.
getExtension() Returns the file extension.
getHeight() Returns the height of the image.
getIsTransparent() Returns whether the image is transparent.
getWidth() Returns the width of the image.
hasMethod() (opens new window) Returns a value indicating whether a method is defined.
hasProperty() (opens new window) Returns a value indicating whether a property is defined.
init() (opens new window) Initializes the object.
loadImage() Loads an image from a file system path.
resize() Resizes the image.
saveAs() Saves the image to the target path.
scaleAndCrop() Scale and crop image to exactly fit the specified size.
scaleToFit() Scale the image to fit within the specified size.

# crop()

Crops the image to the specified coordinates.

View source (opens new window)

Arguments

Returns

static – Self reference

# getExtension()

Returns the file extension.

View source (opens new window)

Returns

string (opens new window)

# getHeight()

Returns the height of the image.

View source (opens new window)

Returns

integer (opens new window)

# getIsTransparent()

Returns whether the image is transparent.

View source (opens new window)

Returns

boolean (opens new window)

# getWidth()

Returns the width of the image.

View source (opens new window)

Returns

integer (opens new window)

# loadImage()

Loads an image from a file system path.

View source (opens new window)

Arguments

Returns

static, craft\image\Svg – Self reference

Throws

# resize()

Resizes the image.

View source (opens new window)

Arguments

Returns

static – Self reference

# saveAs()

Saves the image to the target path.

View source (opens new window)

Arguments

Returns

boolean (opens new window)

Throws

# scaleAndCrop()

Scale and crop image to exactly fit the specified size.

View source (opens new window)

Arguments

Returns

static – Self reference

# scaleToFit()

Scale the image to fit within the specified size.

View source (opens new window)

Arguments

Returns

static – Self reference

# Protected Methods

Method Description
normalizeDimensions() Normalizes the given dimensions. If width or height is set to 'AUTO', we calculate the missing dimension.

# normalizeDimensions()

Normalizes the given dimensions. If width or height is set to 'AUTO', we calculate the missing dimension.

View source (opens new window)

Arguments