ImagesService
- Type
- Class
- Namespace
- Craft
- Inherits
- Craft\ImagesService » Craft\BaseApplicationComponent » CApplicationComponent (opens new window) » CComponent (opens new window)
- Implements
IApplicationComponent- Since
- 1.0
Service for image operations.
See also http://craftcms.com
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| $behaviors (opens new window) | array (opens new window) – The behaviors that should be attached to this component. |
# Public Methods
| Method | Description |
|---|---|
| __call() (opens new window) | Calls the named method which is not a class method. |
| __get() (opens new window) | Returns a property value, an event handler list or a behavior based on its name. |
| __isset() (opens new window) | Checks if a property value is null. |
| __set() (opens new window) | Sets value of a component property. |
| __unset() (opens new window) | Sets a component property to be null. |
| asa() (opens new window) | Returns the named behavior object. |
| attachBehavior() (opens new window) | Attaches a behavior to this component. |
| attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
| attachEventHandler() (opens new window) | Attaches an event handler to an event. |
| canGetProperty() (opens new window) | Determines whether a property can be read. |
| canSetProperty() (opens new window) | Determines whether a property can be set. |
| checkMemoryForImage() | Determines if there is enough memory to process this image. |
| cleanImage() | Cleans an image by it's path, clearing embedded potentially malicious embedded code. |
| detachBehavior() (opens new window) | Detaches a behavior from the component. |
| detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
| detachEventHandler() (opens new window) | Detaches an existing event handler. |
| disableBehavior() (opens new window) | Disables an attached behavior. |
| disableBehaviors() (opens new window) | Disables all behaviors attached to this component. |
| enableBehavior() (opens new window) | Enables an attached behavior. |
| enableBehaviors() (opens new window) | Enables all behaviors attached to this component. |
| evaluateExpression() (opens new window) | Evaluates a PHP expression or callback under the context of this component. |
| getEventHandlers() (opens new window) | Returns the list of attached event handlers for an event. |
| getExifData() | Get EXIF metadata for a file by it's path. |
| getIsInitialized() (opens new window) | Checks if this application component has been initialized. |
| hasEvent() (opens new window) | Determines whether an event is defined. |
| hasEventHandler() (opens new window) | Checks whether the named event has attached handlers. |
| hasProperty() (opens new window) | Determines whether a property is defined. |
| init() (opens new window) | Initializes the application component. |
| isGd() | Returns whether image manipulations will be performed using GD or not. |
| isImagick() | Returns whether image manipulations will be performed using Imagick or not. |
| isInitialized() | Checks if this application component has been initialized yet, or not. |
| loadImage() | Loads an image from a file system path. |
| raiseEvent() (opens new window) | Raises an event. |
| rotateImageByExifData() | Rotate image according to it's EXIF data. |
| stripOrientationFromExifData() | Strip orientation from EXIF data for an image at a path. |
# checkMemoryForImage()
Determines if there is enough memory to process this image. The code was adapted from http://www.php.net/manual/en/function.imagecreatefromjpeg.php#64155. It will first attempt to do it with available memory. If that fails, Craft will bump the memory to amount defined by the phpMaxMemoryLimit (opens new window) config setting, then try again.
View source (opens new window)
Arguments
$filePath(string (opens new window)) – The path to the image file.$toTheMax(boolean (opens new window)) – If set to true, will set the PHP memory to the config setting phpMaxMemoryLimit.
Returns
Signature
public boolean checkMemoryForImage ( $filePath, $toTheMax = false )
# cleanImage()
Cleans an image by it's path, clearing embedded potentially malicious embedded code.
View source (opens new window)
Arguments
$filePath(string (opens new window))
Returns
Throws
Signature
public boolean cleanImage ( $filePath )
# getExifData()
Get EXIF metadata for a file by it's path.
View source (opens new window)
Arguments
$filePath
Returns
Signature
public array getExifData ( $filePath )
# isGd()
Returns whether image manipulations will be performed using GD or not.
View source (opens new window)
Returns
Signature
public boolean, null isGd ( )
# isImagick()
Returns whether image manipulations will be performed using Imagick or not.
View source (opens new window)
Returns
Signature
public boolean isImagick ( )
# loadImage()
Loads an image from a file system path.
View source (opens new window)
Arguments
$path(string (opens new window))$rasterize(boolean (opens new window)) – Whether or not the image will be rasterized if it's an SVG$svgSize(integer (opens new window)) – The size SVG should be scaled up to, if rasterized
Returns
Throws
Signature
public Craft\BaseImage loadImage ( $path, $rasterize = false, $svgSize = 1000 )
# rotateImageByExifData()
Rotate image according to it's EXIF data.
View source (opens new window)
Arguments
$filePath(string (opens new window))
Returns
Signature
public boolean rotateImageByExifData ( $filePath )
# stripOrientationFromExifData()
Strip orientation from EXIF data for an image at a path.
View source (opens new window)
Arguments
$filePath
Returns
Signature
public boolean stripOrientationFromExifData ( $filePath )