DefineSourceSortOptionsEvent
- Type
- Class
- Namespace
- craft\events
- Inherits
- craft\events\DefineSourceSortOptionsEvent » yii\base\Event (opens new window) » yii\base\BaseObject (opens new window)
- Implements
- yii\base\Configurable (opens new window)
- Since
- 3.6.5
DefineSourceSortOptionEvent class.
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| data (opens new window) | mixed – The data that is passed to yii\base\Component::on() (opens new window) when attaching an event handler. |
| elementType | string (opens new window) – The element type class |
| handled (opens new window) | boolean (opens new window) – Whether the event is handled. |
| name (opens new window) | string (opens new window) – The event name. |
| sender (opens new window) | object (opens new window), null (opens new window) – The sender of this event. |
| sortOptions | array (opens new window) – The sort option definitions. |
| source | string (opens new window) – The element source key |
# elementType
- Type
- string (opens new window)
- Default value
null
The element type class
View source (opens new window)
# sortOptions
- Type
- array (opens new window)
- 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)
View source (opens new window)
# source
- Type
- string (opens new window)
- Default value
null
The element source key
View source (opens new window)
# Public Methods
| Method | Description |
|---|---|
| __call() (opens new window) | Calls the named method which is not a class method. |
| __construct() (opens new window) | Constructor. |
| __get() (opens new window) | Returns the value of an object property. |
| __isset() (opens new window) | Checks if a property is set, i.e. defined and not null. |
| __set() (opens new window) | Sets value of an object property. |
| __unset() (opens new window) | Sets an object property to null. |
| canGetProperty() (opens new window) | Returns a value indicating whether a property can be read. |
| canSetProperty() (opens new window) | Returns a value indicating whether a property can be set. |
| className() (opens new window) | Returns the fully qualified name of this class. |
| hasHandlers() (opens new window) | Returns a value indicating whether there is any handler attached to the specified class-level event. |
| hasMethod() (opens new window) | Returns a value indicating whether a method is defined. |
| hasProperty() (opens new window) | Returns a value indicating whether a property is defined. |
| init() (opens new window) | Initializes the object. |
| off() (opens new window) | Detaches an event handler from a class-level event. |
| offAll() (opens new window) | Detaches all registered class-level event handlers. |
| on() (opens new window) | Attaches an event handler to a class-level event. |
| trigger() (opens new window) | Triggers a class-level event. |