Skip to content

DefineSourceSortOptionsEvent

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

DefineSourceSortOptionEvent class.

View source

Public Properties

PropertyDescription
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.
sortOptionsarray – The sort option definitions.
sourcestring – The element source key

elementType

Type
string
Default value
null

The element type class

View source

sortOptions

Type
array
Default value
[]

The sort option definitions.

Each sort option should be defined by an array with the following keys:

  • label – The sort option label
  • orderBy – An array or comma-delimited string of columns to order the query by
  • attribute (optional) – The table attribute name that this option is associated with (required if orderBy is an array or more than one column name)

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.