ElementIndexesService

Type
Class
Namespace
Craft
Inherits
Craft\ElementIndexesService » Craft\BaseApplicationComponent » CApplicationComponent » CComponent
Implements
IApplicationComponent
Since
2.5

ElementIndexesService provides APIs for managing element indexes.

An instance of ElementIndexesService is globally accessible in Craft via {@link WebApp::elementIndexes craft()->elementIndexes}.

See also http://craftcms.com

View source

Public Properties

PropertyDescription
$behaviorsarray – The behaviors that should be attached to this component.

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__get()Returns a property value, an event handler list or a behavior based on its name.
__isset()Checks if a property value is null.
__set()Sets value of a component property.
__unset()Sets a component property to be null.
asa()Returns the named behavior object.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
attachEventHandler()Attaches an event handler to an event.
canGetProperty()Determines whether a property can be read.
canSetProperty()Determines whether a property can be set.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
detachEventHandler()Detaches an existing event handler.
disableBehavior()Disables an attached behavior.
disableBehaviors()Disables all behaviors attached to this component.
enableBehavior()Enables an attached behavior.
enableBehaviors()Enables all behaviors attached to this component.
evaluateExpression()Evaluates a PHP expression or callback under the context of 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.
getEventHandlers()Returns the list of attached event handlers for an event.
getIsInitialized()Checks if this application component has been initialized.
getSettings()Returns the element index settings for a given element type.
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.
hasEvent()Determines whether an event is defined.
hasEventHandler()Checks whether the named event has attached handlers.
hasProperty()Determines whether a property is defined.
init()Initializes the application component.
isInitialized()Checks if this application component has been initialized yet, or not.
raiseEvent()Raises an event.
saveSettings()Saves new element index settings for a given element type.

getAvailableTableAttributes()

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

View source

Arguments

  • $elementTypeClass (string) – The element type class name
  • $includeFields (boolean) – Whether custom fields should be included in the list

Returns

array

Signature

public array getAvailableTableAttributes ( $elementTypeClass, $includeFields = true )

getAvailableTableFields()

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

View source

Arguments

  • $elementTypeClass (string) – The element type class name

Returns

Craft\FieldModel[]

Signature

public Craft\FieldModel[] getAvailableTableFields ( $elementTypeClass )

getSettings()

Returns the element index settings for a given element type.

View source

Arguments

  • $elementTypeClass (string) – The element type class

Returns

array, null

Signature

public array, null getSettings ( $elementTypeClass )

getSources()

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

View source

Arguments

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

Returns

array

Signature

public array getSources ( $elementTypeClass, $context = 'index' )

getTableAttributes()

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

View source

Arguments

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

Returns

array

Signature

public array getTableAttributes ( $elementTypeClass, $sourceKey )

saveSettings()

Saves new element index settings for a given element type.

View source

Arguments

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

Signature

public void saveSettings ( $elementTypeClass, $newSettings )