Class craft\services\ElementIndexes

Inheritance: craft\services\ElementIndexes » yii\base\Component » yii\base\BaseObject
Implements: yii\base\Configurable
Available since version: 3.0
Source Code: https://github.com/craftcms/cms/blob/master/src/services/ElementIndexes.php

The ElementIndexes service provides APIs for managing element indexes.

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

Public Methods
Method	Description	Defined By
`__call()`	Calls the named method which is not a class method.	yii\base\BaseObject
`__clone()`	This method is called after the object is created by cloning an existing one.	yii\base\Component
`__construct()`	Constructor.	yii\base\BaseObject
`__get()`	Returns the value of an object property.	yii\base\BaseObject
`__isset()`	Checks if a property is set, i.e. defined and not null.	yii\base\BaseObject
`__set()`	Sets value of an object property.	yii\base\BaseObject
`__unset()`	Sets an object property to null.	yii\base\BaseObject
`attachBehavior()`	Attaches a behavior to this component.	yii\base\Component
`attachBehaviors()`	Attaches a list of behaviors to the component.	yii\base\Component
`behaviors()`	Returns a list of behaviors that this component should behave as.	yii\base\Component
`canGetProperty()`	Returns a value indicating whether a property can be read.	yii\base\BaseObject
`canSetProperty()`	Returns a value indicating whether a property can be set.	yii\base\BaseObject
`className()`	Returns the fully qualified name of this class.	yii\base\BaseObject
`detachBehavior()`	Detaches a behavior from the component.	yii\base\Component
`detachBehaviors()`	Detaches all behaviors from the component.	yii\base\Component
`ensureBehaviors()`	Makes sure that the behaviors declared in behaviors() are attached to this component.	yii\base\Component
`getAvailableTableAttributes()`	Returns all of the available attributes that can be shown for a given element type source.	craft\services\ElementIndexes
`getAvailableTableFields()`	Returns the fields that are available to be shown as table attributes.	craft\services\ElementIndexes
`getBehavior()`	Returns the named behavior object.	yii\base\Component
`getBehaviors()`	Returns all behaviors attached to this component.	yii\base\Component
`getSettings()`	Returns the element index settings for a given element type.	craft\services\ElementIndexes
`getSources()`	Returns the element index sources in the custom groupings/order.	craft\services\ElementIndexes
`getTableAttributes()`	Returns the attributes that should be shown for a given element type source.	craft\services\ElementIndexes
`hasEventHandlers()`	Returns a value indicating whether there is any handler attached to the named event.	yii\base\Component
`hasMethod()`	Returns a value indicating whether a method is defined.	yii\base\BaseObject
`hasProperty()`	Returns a value indicating whether a property is defined.	yii\base\BaseObject
`init()`	Initializes the object.	yii\base\BaseObject
`off()`	Detaches an existing event handler from this component.	yii\base\Component
`on()`	Attaches an event handler to an event.	yii\base\Component
`saveSettings()`	Saves new element index settings for a given element type.	craft\services\ElementIndexes
`trigger()`	Triggers an event.	yii\base\Component

Method Details

`getAvailableTableAttributes()` public method #

Returns all of the available attributes that can be shown for a given element type source.

public array getAvailableTableAttributes ( \craft\services\string $elementType, \craft\services\bool $includeFields = true )

`$elementType`	string	The element type class
`$includeFields`	boolean	Whether custom fields should be included in the list

`getAvailableTableFields()` public method #

Returns the fields that are available to be shown as table attributes.

public craft\base\FieldInterface[] getAvailableTableFields ( \craft\services\string $elementType )

$elementType string The element type class

`getSettings()` public method #

Returns the element index settings for a given element type.

public array, null getSettings ( \craft\services\string $elementType )

$elementType string The element type class

`getSources()` public method #

Returns the element index sources in the custom groupings/order.

public array getSources ( \craft\services\string $elementType, \craft\services\string $context = 'index' )

`$elementType`	string	The element type class
`$context`	string	The context

`getTableAttributes()` public method #

Returns the attributes that should be shown for a given element type source.

public array getTableAttributes ( \craft\services\string $elementType, \craft\services\string $sourceKey )

`$elementType`	string	The element type class
`$sourceKey`	string	The element type source key

`saveSettings()` public method #

Saves new element index settings for a given element type.

public boolean saveSettings ( \craft\services\string $elementType, array $newSettings )

`$elementType`	string	The element type class
`$newSettings`	array	The new index settings
return	boolean	Whether the settings were saved successfully

Method Details

getAvailableTableAttributes() public method #

getAvailableTableFields() public method #

getSettings() public method #

getSources() public method #