ReplaceAssetEvent

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

Replace asset event class.

View source

Public Properties

PropertyDescription
assetcraft\elements\Asset, null – The asset model associated with the event.
datamixed – The data that is passed to \craft\events\Component::on() when attaching an event handler.
filenamestring, null – The file name that will be used
handledboolean – Whether the event is handled.
isNewboolean – Whether the asset is brand new
isValidboolean – Whether to continue performing the action that called this event
namestring – The event name.
replaceWithstring, null – File on server that is being used to replace
senderobject – The sender of this event.

filename

Type
string, null

The file name that will be used

View source

replaceWith

Type
string, null

File on server that is being used to replace

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.