DefineSourceSortOptionsEvent ​
- Type
- Class
- Namespace
- craft\events
- Inherits
- craft\events\DefineSourceSortOptionsEvent » craft\base\Event » yii\base\Event » yii\base\BaseObject
- Implements
- yii\base\Configurable
- Since
- 3.6.5
DefineSourceSortOptionEvent class.
Public Properties ​
| Property | Description |
|---|---|
| data | mixed – The data that is passed to yii\base\Component::on() when attaching an event handler. |
| elementType | class-string<\craft\base\ElementInterface> – The element type class |
| handled | boolean – Whether the event is handled. |
| name | string – The event name. |
| sender | object, null – The sender of this event. |
| sortOptions | array – The sort option definitions. |
| source | string – The element source key |
elementType ​
- Type
class-string<\craft\base\ElementInterface>- Default value
null
The element type class
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 labelorderBy– An array or comma-delimited string of columns to order the query byattribute(optional) – The table attribute name that this option is associated with (required iforderByis an array or more than one column name)
source ​
- Type
- string
- Default value
null
The element source key
Public Methods ​
| Method | Description |
|---|---|
| __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. |