Image

Type

Abstract Class

Namespace

craft\base

Inherits

craft\base\Image » yii\base\BaseObject

Implements

yii\base\Configurable

Extended by

craft\image\Raster, craft\image\Svg

Since

3.0.0

Base Image class.

View source

Public Properties

Property	Description
extension	string
height	integer
isTransparent	boolean – Whether the image is transparent
width	integer

extension

Type

string

Default value

null

Access

Read-only

View source

height

Type

integer

Default value

null

Access

Read-only

View source

isTransparent

Type

boolean

Default value

null

Whether the image is transparent

View source

width

Type

integer

Default value

null

Access

Read-only

View source

Public Methods

Method	Description
__call()	Calls the named method which is not a class method.
__construct()	Constructor.
__get()	Returns the value of an object property.
__isset()	Checks if a property is set, i.e. defined and not null.
__set()	Sets value of an object property.
__unset()	Sets an object property to null.
canGetProperty()	Returns a value indicating whether a property can be read.
canSetProperty()	Returns a value indicating whether a property can be set.
className()	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()	Returns a value indicating whether a method is defined.
hasProperty()	Returns a value indicating whether a property is defined.
init()	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

Arguments

• $x1 (integer)
• $x2 (integer)
• $y1 (integer)
• $y2 (integer)

Returns

static – Self reference

getExtension()

Returns the file extension.

View source

Returns

string

getHeight()

Returns the height of the image.

View source

Returns

integer

getIsTransparent()

Returns whether the image is transparent.

View source

Returns

boolean

getWidth()

Returns the width of the image.

View source

Returns

integer

loadImage()

Loads an image from a file system path.

View source

Arguments

• $path (string)

Returns

static, craft\image\Svg – Self reference

Throws

• craft\errors\ImageException
  if the file cannot be loaded

resize()

Resizes the image.

View source

Arguments

• $targetWidth (integer, null) – The target width
• $targetHeight (integer, null) – The target height. Defaults to $targetWidth if omitted, creating a square.

Returns

static – Self reference

saveAs()

Saves the image to the target path.

View source

Arguments

• $targetPath (string)
• $autoQuality (boolean)

Returns

boolean

Throws

• craft\errors\ImageException
  if the image cannot be saved.

scaleAndCrop()

Scale and crop image to exactly fit the specified size.

View source

Arguments

• $targetWidth (integer, null)
• $targetHeight (integer, null)
• $scaleIfSmaller (boolean)
• $cropPosition (mixed)

Returns

static – Self reference

scaleToFit()

Scale the image to fit within the specified size.

View source

Arguments

• $targetWidth (integer, null)
• $targetHeight (integer, null)
• $scaleIfSmaller (boolean)

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

Arguments

• $width (integer, string, null)
• $height (integer, string, null)