SaveAssetImageEvent ​
- Type
- Class
- Namespace
- craft\events
- Inherits
- craft\events\SaveAssetImageEvent » craft\events\AssetEvent » craft\events\CancelableEvent » craft\base\Event » yii\base\Event » yii\base\BaseObject
- Implements
- yii\base\Configurable
- Since
- 4.18.1
Save asset image event class.
Public Properties ​
| Property | Description |
|---|---|
| asset | craft\elements\Asset – The asset associated with the event. |
| cropData | array – The crop data posted by the image editor. |
| data | mixed – The data that is passed to yii\base\Component::on() when attaching an event handler. |
| flipData | array, null – The flip data posted by the image editor, if any. |
| focalPoint | array, null – The focal point data posted by the image editor, if any. |
| handled | boolean – Whether the event is handled. |
| imageDimensions | array – The image dimensions posted by the image editor. |
| imageRotation | float – The current image rotation in degrees. |
| isNew | boolean – Whether the asset is brand new |
| isValid | boolean – Whether to continue performing the action that called this event |
| name | string – The event name. |
| newAssetId | integer, null – The ID of the new asset saved by the event handler, if replace is false. |
| replace | boolean – Whether the original asset should be replaced, rather than saving the image as a new asset. |
| sender | object, null – The sender of this event. |
| viewportRotation | integer – The current viewport rotation in degrees. |
| zoom | float – The current image zoom ratio. |
cropData ​
- Type
- array
- Default value
null
The crop data posted by the image editor.
flipData ​
The flip data posted by the image editor, if any.
focalPoint ​
The focal point data posted by the image editor, if any.
imageDimensions ​
- Type
- array
- Default value
null
The image dimensions posted by the image editor.
imageRotation ​
- Type
- float
- Default value
null
The current image rotation in degrees.
newAssetId ​
The ID of the new asset saved by the event handler, if replace is false.
replace ​
- Type
- boolean
- Default value
null
Whether the original asset should be replaced, rather than saving the image as a new asset.
viewportRotation ​
- Type
- integer
- Default value
null
The current viewport rotation in degrees.
zoom ​
- Type
- float
- Default value
1.0
The current image zoom ratio.
Public Methods ​
| Method | Description |
|---|---|
| __call() | Calls the named method which is not a class method. |
| __construct() | |
| __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. |
| hasHandlers() | Returns a value indicating whether there is any handler attached to the specified class-level event. |
| hasMethod() | Returns a value indicating whether a method is defined. |
| hasProperty() | Returns a value indicating whether a property is defined. |
| init() | Initializes the object. |
| off() | Detaches an event handler from a class-level event. |
| offAll() | Detaches all registered class-level event handlers. |
| on() | Attaches an event handler to a class-level event. |
| once() | Attaches an event handler to a class-level event, which will be triggered at most one time. |
| trigger() | Triggers a class-level event. |