ElementIndexes

Type: Class
Namespace: craft\services
Inherits: craft\services\ElementIndexes » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
Implements: yii\base\Configurable (opens new window)
Since: 3.0.0

The Element Indexes service provides APIs for managing element indexes.

An instance of the service is available via Craft::$app->elementIndexes.

# Public Properties

Property	Description
behaviors (opens new window)	yii\base\Behavior (opens new window) – List of behaviors attached to this component.

# Public Methods

Method	Description
__call() (opens new window)	Calls the named method which is not a class method.
__clone() (opens new window)	This method is called after the object is created by cloning an existing one.
__construct() (opens new window)	Constructor.
__get() (opens new window)	Returns the value of a component property.
__isset() (opens new window)	Checks if a property is set, i.e. defined and not null.
__set() (opens new window)	Sets the value of a component property.
__unset() (opens new window)	Sets a component property to be null.
attachBehavior() (opens new window)	Attaches a behavior to this component.
attachBehaviors() (opens new window)	Attaches a list of behaviors to the component.
behaviors() (opens new window)	Returns a list of behaviors that this component should behave as.
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.
detachBehavior() (opens new window)	Detaches a behavior from the component.
detachBehaviors() (opens new window)	Detaches all behaviors from the component.
ensureBehaviors() (opens new window)	Makes sure that the behaviors declared in behaviors() (opens new window) 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() (opens new window)	Returns the named behavior object.
getBehaviors() (opens new window)	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() (opens new window)	Returns a value indicating whether there is any handler attached to the named 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 for this component.
init() (opens new window)	Initializes the object.
off() (opens new window)	Detaches an existing event handler from this component.
on() (opens new window)	Attaches an event handler to an event.
saveSettings()	Saves new element index settings for a given element type.
trigger() (opens new window)	Triggers an event.