AssetThumbEvent

Type
Class
Namespace
craft\events
Inherits
craft\events\AssetThumbEvent » yii\base\Event (opens new window) » yii\base\BaseObject (opens new window)
Implements
yii\base\Configurable (opens new window)
Since
3.0.0

Asset Thumbnail event

View source (opens new window)

# Public Properties

Property Description
asset craft\elements\Asset – The Asset a thumbnail was requested for
data (opens new window) mixed – The data that is passed to yii\base\Component::on() (opens new window) when attaching an event handler.
generate boolean (opens new window) – Whether the thumbnail should be generated if it doesn't exist yet
handled (opens new window) boolean (opens new window) – Whether the event is handled.
height integer (opens new window) – Requested thumbnail height
name (opens new window) string (opens new window) – The event name.
path string (opens new window), false (opens new window), null (opens new window) – 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.
sender (opens new window) object (opens new window) – The sender of this event.
width integer (opens new window) – Requested thumbnail width

# asset

Type
craft\elements\Asset
Default value
null

The Asset a thumbnail was requested for

View source (opens new window)

# generate

Type
boolean (opens new window)
Default value
null

Whether the thumbnail should be generated if it doesn't exist yet

View source (opens new window)

# height

Type
integer (opens new window)
Default value
null

Requested thumbnail height

View source (opens new window)

# path

Type
string (opens new window), false (opens new window), null (opens new window)
Default value
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. Leave null if Craft’s thumbnail generation should be used.

View source (opens new window)

# width

Type
integer (opens new window)
Default value
null

Requested thumbnail width

View source (opens new window)

# Public Methods

Method Description
__call() (opens new window) Calls the named method which is not a class method.
__construct() (opens new window) Constructor.
__get() (opens new window) Returns the value of an object property.
__isset() (opens new window) Checks if a property is set, i.e. defined and not null.
__set() (opens new window) Sets value of an object property.
__unset() (opens new window) Sets an object property to null.
canGetProperty() (opens new window) Returns a value indicating whether a property can be read.
canSetProperty() (opens new window) Returns a value indicating whether a property can be set.
className() (opens new window) Returns the fully qualified name of this class.
hasHandlers() (opens new window) Returns a value indicating whether there is any handler attached to the specified class-level event.
hasMethod() (opens new window) Returns a value indicating whether a method is defined.
hasProperty() (opens new window) Returns a value indicating whether a property is defined.
init() (opens new window) Initializes the object.
off() (opens new window) Detaches an event handler from a class-level event.
offAll() (opens new window) Detaches all registered class-level event handlers.
on() (opens new window) Attaches an event handler to a class-level event.
trigger() (opens new window) Triggers a class-level event.