IndexKeywordsEvent
- Type
- Class
- Namespace
- craft\events
- Inherits
- craft\events\IndexKeywordsEvent » craft\events\CancelableEvent » yii\base\Event (opens new window) » yii\base\BaseObject (opens new window)
- Implements
- yii\base\Configurable (opens new window)
- Since
- 4.2.0
Index keywords event class.
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| attribute | string (opens new window), null (opens new window) – The attribute name being indexed, or null if this is for a custom field |
| data (opens new window) | mixed – The data that is passed to yii\base\Component::on() (opens new window) when attaching an event handler. |
| element | craft\base\ElementInterface – The element being indexed |
| fieldId | integer (opens new window), null (opens new window) – The field ID being indexed, or null if this is for an attribute |
| handled (opens new window) | boolean (opens new window) – Whether the event is handled. |
| isValid | boolean (opens new window) – Whether to continue performing the action that called this event |
| keywords | string (opens new window) – Space-separated list of keywords to be indexed |
| 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. |
# attribute
- Type
- string (opens new window), null (opens new window)
- Default value
null
The attribute name being indexed, or null if this is for a custom field
View source (opens new window)
# element
- Type
- craft\base\ElementInterface
- Default value
null
The element being indexed
View source (opens new window)
# fieldId
- Type
- integer (opens new window), null (opens new window)
- Default value
null
The field ID being indexed, or null if this is for an attribute
View source (opens new window)
# keywords
- Type
- string (opens new window)
- Default value
null
Space-separated list of keywords to be indexed
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. |