Raster

Type

Class

Namespace

craft\image

Inherits

craft\image\Raster » craft\base\Image » yii\base\BaseObject

Implements

yii\base\Configurable

Since

3.0.0

Raster class is used for raster image manipulations.

View source

Public Properties

Property	Description
extension	string
height	integer
imagineImage	\Imagine\Image\AbstractImage, null
interlace	string
isTransparent	boolean – Whether the image is transparent
quality	integer
width	integer

extension

Type

string

Default value

null

Access

Read-only

View source

height

Type

integer

Default value

null

Access

Read-only

View source

imagineImage

Type

\Imagine\Image\AbstractImage, null

Default value

null

Access

Read-only

View source

interlace

Type

string

Default value

null

Access

Write-only

View source

quality

Type

integer

Default value

null

Access

Write-only

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.
disableAnimation()	Disable animation if this is an animated image.
flipHorizontally()	Flips the image horizontally.
flipVertically()	Flips the image vertically.
getExifMetadata()	Returns EXIF metadata for a file by its path.
getExtension()	Returns the file extension.
getHeight()	Returns the height of the image.
getImagineImage()	Return the Imagine Image instance
getIsTransparent()	Returns whether the image is transparent.
getTextBox()	Returns the bounding text box for a text string and an angle
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.
heartbeat()	Let everyone back home know we're ok.
init()	Initializes the object.
loadFromSVG()	Loads an image from an SVG string.
loadImage()	Loads an image from a file system path.
resize()	Resizes the image.
rotate()	Rotates the image by the given degrees.
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.
scaleToFitAndFill()	Scales an image to the target size and fills empty pixels with color.
setFill()	Sets the fill color based on the image's palette.
setFontProperties()	Sets properties for text drawing on the image.
setHeartbeatCallback()	Sets the heartbeat callback.
setInterlace()	Sets the interlace setting.
setQuality()	Sets the image quality.
writeText()	Writes text on an image.

__construct()

Constructor.

The default implementation does two things:

• Initializes the object with the given configuration $config.
• Call init().

If this method is overridden in a child class, it is recommended that

• the last parameter of the constructor is a configuration array, like $config here.
• call the parent implementation at the end of the constructor.

View source

Arguments

• $config (array) – Name-value pairs that will be used to initialize the object properties

crop()

Crops the image to the specified coordinates.

View source

Arguments

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

Returns

static – Self reference

disableAnimation()

Disable animation if this is an animated image.

View source

Returns

self – Self-reference

flipHorizontally()

Flips the image horizontally.

View source

Returns

self – Self reference

flipVertically()

Flips the image vertically.

View source

Returns

self – Self reference

getExifMetadata()

Returns EXIF metadata for a file by its path.

View source

Arguments

• $filePath (string)

Returns

array

getExtension()

Returns the file extension.

View source

Returns

string

getHeight()

Returns the height of the image.

View source

Returns

integer

getImagineImage()

Return the Imagine Image instance

View source

Returns

\Imagine\Image\AbstractImage, null

getIsTransparent()

Returns whether the image is transparent.

View source

Returns

boolean

getTextBox()

Returns the bounding text box for a text string and an angle

View source

Arguments

• $text (string)
• $angle (integer)

Returns

\Imagine\Image\BoxInterface

Throws

• craft\errors\ImageException
  if attempting to create text box with no font properties

getWidth()

Returns the width of the image.

View source

Returns

integer

loadFromSVG()

Loads an image from an SVG string.

View source

Arguments

• $svgContent (string)

Returns

self – Self reference

Throws

• craft\errors\ImageException
  if the SVG string cannot be loaded.

loadImage()

Loads an image from a file system path.

View source

Arguments

• $path (string)

Returns

static – 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

rotate()

Rotates the image by the given degrees.

View source

Arguments

• $degrees (float)

Returns

self – 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 (string, string[])

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

scaleToFitAndFill()

Since

4.4.0

Scales an image to the target size and fills empty pixels with color.

View source

Arguments

• $targetWidth (integer, null)
• $targetHeight (integer, null)
• $fill (string, null)
• $position (string, array)
• $upscale (boolean, null)

Returns

craft\image\Raster

setFill()

Since

4.4.0

Sets the fill color based on the image's palette.

View source

Arguments

• $fill (string) – Hex color of the fill.

Returns

$this – Self reference

setFontProperties()

Sets properties for text drawing on the image.

View source

Arguments

• $fontFile (string) – Path to the font file on server
• $size (integer) – Font size to use
• $color (string) – Font color to use in hex format

setInterlace()

Sets the interlace setting.

View source

Arguments

• $interlace (string)

Returns

self – Self reference

setQuality()

Sets the image quality.

View source

Arguments

• $quality (integer)

Returns

self – Self reference

writeText()

Writes text on an image.

View source

Arguments

• $text (string)
• $x (integer)
• $y (integer)
• $angle (integer)

Throws

• craft\errors\ImageException
  If attempting to create text box with no font properties et.

Protected Methods

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