Class craft\events\AssetThumbEvent
- Inheritance
- craft\events\AssetThumbEvent » 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/AssetThumbEvent.php
Asset Thumbnail event
| Property | Type | Description | Defined By |
|---|---|---|---|
$asset |
craft\elements\Asset | The Asset a thumbnail was requested for | craft\events\AssetThumbEvent |
$data |
mixed | The data that is passed to yii\base\Component::on() when attaching an event handler. | yii\base\Event |
$generate |
boolean | Whether the thumbnail should be generated if it doesn't exist yet | craft\events\AssetThumbEvent |
$handled |
boolean | Whether the event is handled. | yii\base\Event |
$height |
integer | Requested thumbnail height | craft\events\AssetThumbEvent |
$name |
string | The event name. | yii\base\Event |
$path |
string, false, null | Thumbnail path that should be used in place of the
Craft-defined thumbnail path, or false if one doesn't exist yet and
$generate is false. |
craft\events\AssetThumbEvent |
$sender |
object | The sender of this event. | yii\base\Event |
$width |
integer | Requested thumbnail width | craft\events\AssetThumbEvent |
| 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
$asset
public property
#
The Asset a thumbnail was requested for
public craft\elements\Asset $asset = null
$generate
public property
#
Whether the thumbnail should be generated if it doesn't exist yet
public boolean $generate = null
$height
public property
#
Requested thumbnail height
public integer $height = null
$path
public property
#
Thumbnail path that should be used in place of the
Craft-defined thumbnail path, or false if one doesn't exist yet and
$generate is false. Leave null if Craft’s thumbnail generation
should be used.
public string, false, null $path = null
$width
public property
#
Requested thumbnail width
public integer $width = null