BaseImage

Type
Abstract Class
Namespace
Craft
Inherits
Craft\BaseImage
Extended by
Craft\Image, Craft\SvgImage
Since
2.5

Base Image class

See also http://craftcms.com

View source

Public Methods

MethodDescription
crop()Crops the image to the specified coordinates.
getExtension()
getHeight()
getWidth()
isTransparent()Returns true if the image is transparent.
loadImage()Loads an image from a file system path.
resize()Re-sizes the image. If $height is not specified, it will default to $width, creating a square.
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

Craft\BaseImage

Signature

public abstract Craft\BaseImage crop ( $x1, $x2, $y1, $y2 )

getExtension()

Signature

public abstract string getExtension ( )

getHeight()

Signature

public abstract integer getHeight ( )

getWidth()

Signature

public abstract integer getWidth ( )

isTransparent()

Returns true if the image is transparent.

View source

Returns

boolean

Signature

public abstract boolean isTransparent ( )

loadImage()

Loads an image from a file system path.

View source

Arguments

Returns

Craft\BaseImage

Throws

Signature

public abstract Craft\BaseImage loadImage ( $path )

resize()

Re-sizes the image. If $height is not specified, it will default to $width, creating a square.

View source

Arguments

Returns

Craft\Image

Signature

public abstract Craft\Image resize ( $targetWidth, $targetHeight = null )

saveAs()

Saves the image to the target path.

View source

Arguments

  • $targetPath (string)
  • $autoQuality

Returns

null

Signature

public abstract null saveAs ( $targetPath, $autoQuality = false )

scaleAndCrop()

Scale and crop image to exactly fit the specified size.

View source

Arguments

Returns

Craft\BaseImage

Signature

public abstract Craft\BaseImage scaleAndCrop ( $targetWidth, $targetHeight = null, $scaleIfSmaller = true, $cropPositions = 'center-center' )

scaleToFit()

Scale the image to fit within the specified size.

View source

Arguments

Returns

Craft\BaseImage

Signature

public abstract Craft\BaseImage scaleToFit ( $targetWidth, $targetHeight = null, $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

Throws

Signature

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