GetAssetThumbUrlEvent

Type
Class
Namespace
craft\events
Inherits
craft\events\GetAssetThumbUrlEvent » yii\base\Event » yii\base\BaseObject
Implements
yii\base\Configurable
Since
3.0.0

Get Asset thumb url event class

View source

Public Properties

PropertyDescription
assetcraft\elements\Asset – The Asset which the thumbnail should be 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.
senderobject – The sender of this event.
sizeinteger – Requested thumbnail size (width and height)
urlstring, null – Url to requested Asset that should be used instead.
widthinteger – Requested thumbnail width

asset

Type
craft\elements\Asset

The Asset which the thumbnail should be for.

View source

generate

Type
boolean

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

View source

height

Type
integer

Requested thumbnail height

View source

size

DEPRECATED

Deprecated in 3.0.0-RC7. Use width and height instead

Type
integer

Requested thumbnail size (width and height)

View source

url

Type
string, null

Url to requested Asset that should be used instead.

View source

width

Type
integer

Requested thumbnail width

View source

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.