ElementIndexesService
- Type
- Class
- Namespace
- Craft
- Inherits
- Craft\ElementIndexesService » Craft\BaseApplicationComponent » CApplicationComponent (opens new window) » CComponent (opens new window)
- 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 (opens new window)
# Public Properties
| Property | Description |
|---|---|
| $behaviors (opens new window) | array (opens new window) – The behaviors that should be attached to this component. |
# Public Methods
| Method | Description |
|---|---|
| __call() (opens new window) | Calls the named method which is not a class method. |
| __get() (opens new window) | Returns a property value, an event handler list or a behavior based on its name. |
| __isset() (opens new window) | Checks if a property value is null. |
| __set() (opens new window) | Sets value of a component property. |
| __unset() (opens new window) | Sets a component property to be null. |
| asa() (opens new window) | Returns the named behavior object. |
| attachBehavior() (opens new window) | Attaches a behavior to this component. |
| attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
| attachEventHandler() (opens new window) | Attaches an event handler to an event. |
| canGetProperty() (opens new window) | Determines whether a property can be read. |
| canSetProperty() (opens new window) | Determines whether a property can be set. |
| detachBehavior() (opens new window) | Detaches a behavior from the component. |
| detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
| detachEventHandler() (opens new window) | Detaches an existing event handler. |
| disableBehavior() (opens new window) | Disables an attached behavior. |
| disableBehaviors() (opens new window) | Disables all behaviors attached to this component. |
| enableBehavior() (opens new window) | Enables an attached behavior. |
| enableBehaviors() (opens new window) | Enables all behaviors attached to this component. |
| evaluateExpression() (opens new window) | 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() (opens new window) | Returns the list of attached event handlers for an event. |
| getIsInitialized() (opens new window) | 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() (opens new window) | Determines whether an event is defined. |
| hasEventHandler() (opens new window) | Checks whether the named event has attached handlers. |
| hasProperty() (opens new window) | Determines whether a property is defined. |
| init() (opens new window) | Initializes the application component. |
| isInitialized() | Checks if this application component has been initialized yet, or not. |
| raiseEvent() (opens new window) | 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 (opens new window)
Arguments
$elementTypeClass(string (opens new window)) – The element type class name$includeFields(boolean (opens new window)) – Whether custom fields should be included in the list
Returns
Signature
public array getAvailableTableAttributes ( $elementTypeClass, $includeFields = true )
# getAvailableTableFields()
Returns the fields that are available to be shown as table attributes.
View source (opens new window)
Arguments
$elementTypeClass(string (opens new window)) – The element type class name
Returns
Signature
public Craft\FieldModel[] getAvailableTableFields ( $elementTypeClass )
# getSettings()
Returns the element index settings for a given element type.
View source (opens new window)
Arguments
$elementTypeClass(string (opens new window)) – The element type class
Returns
Signature
public array, null getSettings ( $elementTypeClass )
# getSources()
Returns the element index sources in the custom groupings/order.
View source (opens new window)
Arguments
$elementTypeClass(string (opens new window)) – The element type class$context(string (opens new window)) – The context
Returns
Signature
public array getSources ( $elementTypeClass, $context = 'index' )
# getTableAttributes()
Returns the attributes that should be shown for a given element type source.
View source (opens new window)
Arguments
$elementTypeClass(string (opens new window)) – The element type class name$sourceKey(string (opens new window)) – The element type source key
Returns
Signature
public array getTableAttributes ( $elementTypeClass, $sourceKey )
# saveSettings()
Saves new element index settings for a given element type.
View source (opens new window)
Arguments
$elementTypeClass(string (opens new window)) – The element type class$newSettings(array (opens new window)) – The new index settings
Signature
public void saveSettings ( $elementTypeClass, $newSettings )