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

Base Image class.

View source

Public Properties

$extension

Type
string
Access
Read-only

View source

Signature

public abstract string getExtension ( )

$height

Type
integer
Access
Read-only

View source

Signature

public abstract integer getHeight ( )

$isTransparent

Type
boolean
Access
Read-only

View source

Signature

public abstract boolean getIsTransparent ( )

$width

Type
integer
Access
Read-only

View source

Signature

public abstract integer getWidth ( )

Public Methods

MethodDescription
__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

Returns

static – Self reference

Signature

public abstract static crop ( \craft\base\int $x1, \craft\base\int $x2, \craft\base\int $y1, \craft\base\int $y2 )

getExtension()

Returns the file extension.

View source

Returns

string

Signature

public abstract string getExtension ( )

getHeight()

Returns the height of the image.

View source

Returns

integer

Signature

public abstract integer getHeight ( )

getIsTransparent()

Returns whether the image is transparent.

View source

Returns

boolean

Signature

public abstract boolean getIsTransparent ( )

getWidth()

Returns the width of the image.

View source

Returns

integer

Signature

public abstract integer getWidth ( )

loadImage()

Loads an image from a file system path.

View source

Arguments

Returns

static, craft\image\Svg – Self reference

Throws

Signature

public abstract static, craft\image\Svg loadImage ( \craft\base\string $path )

resize()

Resizes the image.

View source

Arguments

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

Returns

static – Self reference

Signature

public abstract static resize ( \craft\base\int $targetWidth, \craft\base\int $targetHeight = null )

saveAs()

Saves the image to the target path.

View source

Arguments

Returns

boolean

Throws

Signature

public abstract boolean saveAs ( \craft\base\string $targetPath, \craft\base\bool $autoQuality = false )

scaleAndCrop()

Scale and crop image to exactly fit the specified size.

View source

Arguments

Returns

static – Self reference

Signature

public abstract static scaleAndCrop ( \craft\base\int $targetWidth = null, \craft\base\int $targetHeight = null, \craft\base\bool $scaleIfSmaller = true, $cropPosition = 'center-center' )

scaleToFit()

Scale the image to fit within the specified size.

View source

Arguments

Returns

static – Self reference

Signature

public abstract static scaleToFit ( \craft\base\int $targetWidth, \craft\base\int $targetHeight = null, \craft\base\bool $scaleIfSmaller = true )

Protected Methods

MethodDescription
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

Signature

protected void normalizeDimensions ( &$width, &$height )