AssetThumbEvent

Type
Class
Namespace
craft\events
Inherits
craft\events\AssetThumbEvent » yii\base\Event » yii\base\BaseObject
Implements
yii\base\Configurable
Since
3.0

Asset Thumbnail event

View source

Public Properties

PropertyDescription
$assetcraft\elements\Asset – The Asset a thumbnail was requested for
$datamixed – The data that is passed to \craft\events\Component::on() when attaching an event handler.
$generateboolean – Whether the thumbnail should be generated if it doesn't exist yet
$handledboolean – Whether the event is handled.
$heightinteger – Requested thumbnail height
$namestring – The event name.
$pathstring, 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.
$senderobject – The sender of this event.
$widthinteger – Requested thumbnail width

$asset

Type
craft\elements\Asset

The Asset a thumbnail was requested for

View source

Signature

public craft\elements\Asset $asset = null

$generate

Type
boolean

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

View source

Signature

public boolean $generate = null

$height

Type
integer

Requested thumbnail height

View source

Signature

public integer $height = null

$path

Type
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. Leave null if Craft’s thumbnail generation should be used.

View source

Signature

public string, false, null $path = null

$width

Type
integer

Requested thumbnail width

View source

Signature

public integer $width = null

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__construct()Constructor.
__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.
trigger()Triggers a class-level event.