ImageDriver class - Documentation for SproutCMS

Info Page:

Page options:

class ImageDriver

Image API driver.

Name	Visibility	Description
crop	public	Crop an image. Valid properties are: width, height, top, left.
execute	public	Executes a set of actions, defined in pairs.
flip	public	Flip an image. Valid directions are horizontal and vertical.
process	public	Process an image with a set of actions.
properties	protected	Return the current width and height of the temporary image. This is mainly
resize	public	Resize an image. Valid properties are: width, height, and master.
rotate	public	Rotate an image. Valid amounts are -180 to 180.
sanitizeGeometry	protected	Sanitize and normalize a geometry array based on the temporary image
sharpen	public	Sharpen and image. Valid amounts are 1 to 100.

boolean $ImageDriver->crop ( array $properties );

Crop an image. Valid properties are: width, height, top, left.

boolean $ImageDriver->execute ( array $actions );

Executes a set of actions, defined in pairs.

boolean $ImageDriver->flip ( integer $direction );

Flip an image. Valid directions are horizontal and vertical.

boolean $ImageDriver->process ( string $image , array $actions , string $dir , string $file );

Process an image with a set of actions.

array $ImageDriver->properties ( );

Return the current width and height of the temporary image. This is mainly
needed for sanitizing the geometry.

boolean $ImageDriver->resize ( array $properties );

Resize an image. Valid properties are: width, height, and master.

boolean $ImageDriver->rotate ( integer $amount );

Rotate an image. Valid amounts are -180 to 180.

void $ImageDriver->sanitizeGeometry ( array &$geometry );

Sanitize and normalize a geometry array based on the temporary image
width and height. Valid properties are: width, height, top, left.

boolean $ImageDriver->sharpen ( integer $amount );

Sharpen and image. Valid amounts are 1 to 100.