Craft 3 Class Reference

Class craft\events\GenerateTransformEvent

Inheritance
craft\events\GenerateTransformEvent » craft\events\AssetTransformImageEvent » craft\events\AssetEvent » craft\events\CancelableEvent » yii\base\Event » yii\base\BaseObject
Implements
yii\base\Configurable
Available since version
3.0
Source Code
https://github.com/craftcms/cms/blob/master/src/events/GenerateTransformEvent.php

Asset generate transform event class.

Public Properties
Property Type Description Defined By
$asset craft\elements\Asset, null The asset model associated with the event. craft\events\AssetEvent
$data mixed The data that is passed to yii\base\Component::on() when attaching an event handler. yii\base\Event
$handled boolean Whether the event is handled. yii\base\Event
$image craft\base\Image craft\events\GenerateTransformEvent
$isNew boolean Whether the asset is brand new craft\events\AssetEvent
$isValid boolean Whether to continue performing the action that called this event craft\events\CancelableEvent
$name string The event name. yii\base\Event
$sender object The sender of this event. yii\base\Event
$tempPath string, null Path to the modified image that should be used instead. craft\events\GenerateTransformEvent
$transformIndex craft\models\AssetTransformIndex Asset transform index that is being generated. craft\events\AssetTransformImageEvent
Public Methods
Method Description Defined By
__call() Calls the named method which is not a class method. yii\base\BaseObject
__construct() Constructor. yii\base\BaseObject
__get() Returns the value of an object property. yii\base\BaseObject
__isset() Checks if a property is set, i.e. defined and not null. yii\base\BaseObject
__set() Sets value of an object property. yii\base\BaseObject
__unset() Sets an object property to null. yii\base\BaseObject
canGetProperty() Returns a value indicating whether a property can be read. yii\base\BaseObject
canSetProperty() Returns a value indicating whether a property can be set. yii\base\BaseObject
className() Returns the fully qualified name of this class. yii\base\BaseObject
hasHandlers() Returns a value indicating whether there is any handler attached to the specified class-level event. yii\base\Event
hasMethod() Returns a value indicating whether a method is defined. yii\base\BaseObject
hasProperty() Returns a value indicating whether a property is defined. yii\base\BaseObject
init() Initializes the object. yii\base\BaseObject
off() Detaches an event handler from a class-level event. yii\base\Event
offAll() Detaches all registered class-level event handlers. yii\base\Event
on() Attaches an event handler to a class-level event. yii\base\Event
trigger() Triggers a class-level event. yii\base\Event

Property Details

$image public property #

public craft\base\Image $image null

$tempPath public property #

Path to the modified image that should be used instead.

public string, null $tempPath null