ElementIndexes

Type: Class
Namespace: craft\services
Inherits: craft\services\ElementIndexes » yii\base\Component » yii\base\BaseObject
Implements: yii\base\Configurable
Since: 3.0.0

The ElementIndexes service provides APIs for managing element indexes.

An instance of ElementIndexes service is globally accessible in Craft via Craft::$app->elementIndexes.

# Public Properties

Property	Description
behaviors	yii\base\Behavior – List of behaviors attached to this component

# Public Methods

Method	Description
__call()	Calls the named method which is not a class method.
__clone()	This method is called after the object is created by cloning an existing one.
__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.
attachBehavior()	Attaches a behavior to this component.
attachBehaviors()	Attaches a list of behaviors to the component.
behaviors()	Returns a list of behaviors that this component should behave as.
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.
detachBehavior()	Detaches a behavior from the component.
detachBehaviors()	Detaches all behaviors from the component.
ensureBehaviors()	Makes sure that the behaviors declared in behaviors() are attached to this component.
getAvailableTableAttributes()	Returns all of the available attributes that can be shown for a given element type source.
getAvailableTableFields()	Returns the fields that are available to be shown as table attributes.
getBehavior()	Returns the named behavior object.
getBehaviors()	Returns all behaviors attached to this component.
getFieldLayoutsForSource()	Returns all the field layouts available for the given element source.
getSettings()	Returns the element index settings for a given element type.
getSourceSortOptions()	Returns additional sort options that should be available for a given element source.
getSourceTableAttributes()	Returns additional table attributes that should be available for a given source.
getSources()	Returns the element index sources in the custom groupings/order.
getTableAttributes()	Returns the attributes that should be shown for a given element type source.
hasEventHandlers()	Returns a value indicating whether there is any handler attached to the named 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 existing event handler from this component.
on()	Attaches an event handler to an event.
saveSettings()	Saves new element index settings for a given element type.
trigger()	Triggers an event.