Skip to content

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 Element Indexes service provides APIs for managing element indexes.

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

View source

Public Properties

PropertyDescription
behaviorsyii\base\Behavior – List of behaviors attached to this component.

Public Methods

MethodDescription
__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 a component property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets the value of a component property.
__unset()Sets a component property to be 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 for this component.
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.

getAvailableTableAttributes()

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

View source

Arguments

  • $elementType (string) – The element type class

Returns

array

getAvailableTableFields()

DEPRECATED

Deprecated in 3.5.0. Use getSourceTableAttributes() instead.

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

View source

Arguments

  • $elementType (string) – The element type class

Returns

craft\base\FieldInterface[]

getFieldLayoutsForSource()

Since
3.5.0

Returns all the field layouts available for the given element source.

View source

Arguments

Returns

craft\models\FieldLayout[]

getSettings()

Returns the element index settings for a given element type.

View source

Arguments

  • $elementType (string) – The element type class

Returns

array, null

getSourceSortOptions()

Since
3.5.0

Returns additional sort options that should be available for a given element source.

View source

Arguments

  • $elementType (string) – The element type class
  • $sourceKey (string) – The element source key

Returns

array

getSourceTableAttributes()

Since
3.5.0

Returns additional table attributes that should be available for a given source.

View source

Arguments

  • $elementType (string) – The element type class
  • $sourceKey (string) – The element source key

Returns

array

getSources()

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

View source

Arguments

  • $elementType (string) – The element type class
  • $context (string) – The context

Returns

array

getTableAttributes()

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

View source

Arguments

  • $elementType (string) – The element type class
  • $sourceKey (string) – The element type source key

Returns

array

saveSettings()

Saves new element index settings for a given element type.

View source

Arguments

  • $elementType (string) – The element type class
  • $newSettings (array) – The new index settings

Returns

boolean – Whether the settings were saved successfully

Events

EVENT_DEFINE_SOURCE_SORT_OPTIONS

Type
craft\events\DefineSourceSortOptionsEvent
Since
3.6.5

The event that is triggered when defining the available sort options for a source.


EVENT_DEFINE_SOURCE_TABLE_ATTRIBUTES

Type
craft\events\DefineSourceTableAttributesEvent
Since
3.6.5

The event that is triggered when defining the available table attributes for a source.