Skip to content

DefineElementHtmlEvent

Type
Class
Namespace
craft\events
Inherits
craft\events\DefineElementHtmlEvent » craft\events\ElementEvent » craft\events\CancelableEvent » yii\base\Event » yii\base\BaseObject
Implements
yii\base\Configurable
Since
5.0.0

DefineElementHtmlEvent class.

View source

Public Properties

PropertyDescription
contextstring – The context the element is going to be shown in (index, field, etc.).
datamixed – The data that is passed to yii\base\Component::on() when attaching an event handler.
elementcraft\base\ElementInterface – The element model associated with the event.
handledboolean – Whether the event is handled.
htmlstring – The element’s pre-rendered chip or card HTML
isNewboolean – Whether the element is brand new
isValidboolean – Whether to continue performing the action that called this event
namestring – The event name.
senderobject, null – The sender of this event.

context

Type
string
Default value
null

The context the element is going to be shown in (index, field, etc.).

View source

html

Type
string
Default value
null

The element’s pre-rendered chip or card HTML

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.