Skip to content

IndexKeywordsEvent

Type
Class
Namespace
craft\events
Inherits
craft\events\IndexKeywordsEvent » craft\events\CancelableEvent » yii\base\Event » yii\base\BaseObject
Implements
yii\base\Configurable
Since
4.2.0

Index keywords event class.

View source

Public Properties

PropertyDescription
attributestring, null – The attribute name being indexed, or null if this is for a custom field
datamixed – The data that is passed to yii\base\Component::on() when attaching an event handler.
elementcraft\base\ElementInterface – The element being indexed
fieldIdinteger, null – The field ID being indexed, or null if this is for an attribute
handledboolean – Whether the event is handled.
isValidboolean – Whether to continue performing the action that called this event
keywordsstring – Space-separated list of keywords to be indexed
namestring – The event name.
senderobject, null – The sender of this event.

attribute

Type
string, null
Default value
null

The attribute name being indexed, or null if this is for a custom field

View source

element

Type
craft\base\ElementInterface
Default value
null

The element being indexed

View source

fieldId

Type
integer, null
Default value
null

The field ID being indexed, or null if this is for an attribute

View source

keywords

Type
string
Default value
null

Space-separated list of keywords to be indexed

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.