Skip to content

DefineSourceTableAttributesEvent

Type
Class
Namespace
craft\events
Inherits
craft\events\DefineSourceTableAttributesEvent » yii\base\Event » yii\base\BaseObject
Implements
yii\base\Configurable
Since
3.6.5

DefineSourceTableAttributesEvent class.

View source

Public Properties

PropertyDescription
attributesarray – The available columns that can be shown.
datamixed – The data that is passed to yii\base\Component::on() when attaching an event handler.
elementTypestring – The element type class
handledboolean – Whether the event is handled.
namestring – The event name.
senderobject, null – The sender of this event.
sourcestring – The element source key

attributes

Type
array
Default value
[]

The available columns that can be shown.

This should be set to an array whose keys represent element attribute names, and whose values are nested arrays with the following keys:

  • label – The table column header
  • icon (optional) – The name of the icon that should be shown instead of a textual label (e.g. 'world')

The first item in the array will determine the first table column’s header (and which sort option it should be mapped to, if any), however it doesn’t have any effect on the table body, because the first column is reserved for displaying whatever the elements’ getUiLabel() methods return.

View source

elementType

Type
string
Default value
null

The element type class

View source

source

Type
string
Default value
null

The element source key

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.