ElementSources
- Type
- Class
- Namespace
- craft\services
- Inherits
- craft\services\ElementSources » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
- Implements
- yii\base\Configurable (opens new window)
- Since
- 4.0.0
The Element Sources service provides APIs for managing element indexes.
An instance of the service is available via Craft::$app->elementSources.
View source (opens new window)
# 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. |
| filterExtraHeadings() | Filters out any unnecessary headings from a given source list. |
| getAvailableTableAttributes() | Returns the common table attributes that are available for a given element type, across all its sources. |
| 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. |
| getSourceSortOptions() | Returns additional sort options that should be available for a given element source. |
| getSourceTableAttributes() | Returns any table attributes that should be available for a given source, in addition to the common attributes. |
| 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. |
| trigger() (opens new window) | Triggers an event. |
# filterExtraHeadings()
Filters out any unnecessary headings from a given source list.
View source (opens new window)
Arguments
$sources(array (opens new window)[])
Returns
# getAvailableTableAttributes()
Returns the common table attributes that are available for a given element type, across all its sources.
View source (opens new window)
Arguments
$elementType(string (opens new window)) – The element type class
Returns
# getFieldLayoutsForSource()
Returns all the field layouts available for the given element source.
View source (opens new window)
Arguments
$elementType(string (opens new window))$sourceKey(string (opens new window))
Returns
# getSourceSortOptions()
Returns additional sort options that should be available for a given element source.
View source (opens new window)
Arguments
$elementType(string (opens new window)) – The element type class$sourceKey(string (opens new window)) – The element source key
Returns
# getSourceTableAttributes()
Returns any table attributes that should be available for a given source, in addition to the common attributes.
View source (opens new window)
Arguments
$elementType(string (opens new window)) – The element type class$sourceKey(string (opens new window)) – The element source key
Returns
# getSources()
Returns the element index sources in the custom groupings/order.
View source (opens new window)
Arguments
$elementType(string (opens new window)) – The element type class$context(string (opens new window)) – The context$withDisabled(boolean (opens new window)) – Whether disabled sources should be included
Returns
# getTableAttributes()
Returns the attributes that should be shown for a given element type source.
View source (opens new window)
Arguments
$elementType(string (opens new window)) – The element type class$sourceKey(string (opens new window)) – The element type source key$customAttributes(string (opens new window)[], null (opens new window)) – Custom attributes to show rather than the defaults
Returns
# Constants
| Constant | Description |
|---|---|
CONTEXT_FIELD | |
CONTEXT_INDEX | |
CONTEXT_MODAL | |
CONTEXT_SETTINGS | |
TYPE_CUSTOM | |
TYPE_HEADING | |
TYPE_NATIVE |
# Events
# EVENT_DEFINE_SOURCE_SORT_OPTIONS
The event that is triggered when defining the available sort options for a source.
# EVENT_DEFINE_SOURCE_TABLE_ATTRIBUTES
The event that is triggered when defining the available table attributes for a source.