Skip to content

ElementIndexTableAttributeEvent ​

Type
Class
Namespace
craft\events
Inherits
craft\events\ElementIndexTableAttributeEvent » craft\base\Event » yii\base\Event » yii\base\BaseObject
Implements
yii\base\Configurable
Since
3.7.14

Table attribute Element Query preparation event

Triggered while preparing an element query for an element index, for each attribute present in the table.

View source

Public Properties ​

PropertyDescription
attributestring – The table attribute name, as registered by the Element, and not implicitly a native field or attribute name.
datamixed – The data that is passed to yii\base\Component::on() when attaching an event handler.
handledboolean – Whether the event is handled.
namestring – The event name.
querycraft\elements\db\ElementQueryInterface – The Element query being built
senderobject, null – The sender of this event.

attribute ​

Type
string
Default value
null

The table attribute name, as registered by the Element, and not implicitly a native field or attribute name.

View source

query ​

Type
craft\elements\db\ElementQueryInterface
Default value
null

The Element query being built

View source

Public Methods ​

MethodDescription
__call()Calls the named method which is not a class method.
__construct()
__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.
once()Attaches an event handler to a class-level event, which will be triggered at most one time.
trigger()Triggers a class-level event.