ElementIndexesController

Type: Class
Namespace: craft\controllers
Inherits: craft\controllers\ElementIndexesController » craft\controllers\BaseElementsController » craft\web\Controller » yii\web\Controller (opens new window) » yii\base\Controller (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
Implements: yii\base\Configurable (opens new window), yii\base\ViewContextInterface (opens new window)
Since: 3.0.0

The ElementIndexesController class is a controller that handles various element index related actions.

Note that all actions in the controller require an authenticated Craft session via allowAnonymous.

# Public Properties

Property	Description
action (opens new window)	yii\base\Action (opens new window), null (opens new window) – The action that is currently being executed.
actionParams (opens new window)	array (opens new window) – The parameters bound to the current action.
behaviors (opens new window)	yii\base\Behavior (opens new window) – List of behaviors attached to this component.
defaultAction (opens new window)	string (opens new window) – The ID of the action that is used when the action ID is not specified in the request.
enableCsrfValidation (opens new window)	boolean (opens new window) – Whether to enable CSRF validation for the actions in this controller.
id (opens new window)	string (opens new window) – The ID of this controller.
layout (opens new window)	string (opens new window), null (opens new window), false (opens new window) – The name of the layout to be applied to this controller's views.
module (opens new window)	yii\base\Module (opens new window) – The module that this controller belongs to.
modules (opens new window)	yii\base\Module (opens new window) – All ancestor modules that this controller is located within.
request	craft\web\Request
response	craft\web\Response
route (opens new window)	string (opens new window) – The route (module ID, controller ID and action ID) of the current request.
uniqueId (opens new window)	string (opens new window) – The controller ID that is prefixed with the module ID (if any).
view	craft\web\View – The view object that can be used to render views or view files
viewPath (opens new window)	string (opens new window) – The directory containing the view files for this controller.

# Protected Properties

Property	Description
actions	craft\base\ElementActionInterface[], null (opens new window)
allowAnonymous	integer (opens new window), boolean (opens new window), integer (opens new window)[], string (opens new window)[] – Whether this controller’s actions can be accessed anonymously.
context	string (opens new window), null (opens new window)
elementQuery	craft\elements\db\ElementQueryInterface, craft\elements\db\ElementQuery, null (opens new window)
elementType	string (opens new window), null (opens new window)
exporters	craft\base\ElementExporterInterface[], null (opens new window)
paginated	boolean (opens new window)
source	array (opens new window), null (opens new window)
sourceKey	string (opens new window), null (opens new window)
viewState	array (opens new window), null (opens new window)

# `paginated`

DEPRECATED

Deprecated in 3.4.6

Type: boolean (opens new window)
Default value: false

View source (opens new window)

# `source`

Type: array (opens new window), null (opens new window)
Default value: null

View source (opens new window)

# `sourceKey`

Type: string (opens new window), null (opens new window)
Default value: null

View source (opens new window)

# `viewState`

Type: array (opens new window), null (opens new window)
Default value: null

View source (opens new window)

# 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)
__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.
actionCountElements()	Returns the total number of elements that match the current criteria.
actionExport()	Exports element data.
actionGetElements()	Renders and returns an element index container, plus its first batch of elements.
actionGetMoreElements()	Renders and returns a subsequent batch of elements for an element index.
actionGetSourceTreeHtml()	Returns the source tree HTML for an element index.
actionPerformAction()	Performs an action on one or more selected elements.
actionSourcePath()	Returns the source path for the given source key, step key, and context.
actions() (opens new window)	Declares external actions for the controller.
afterAction() (opens new window)	This method is invoked right after an action is executed.
asErrorJson()	Responds to the request with a JSON error message.
asJson() (opens new window)	Send data formatted as JSON.
asJsonP()	Sets the response format of the given data as JSONP.
asRaw()	Sets the response format of the given data as RAW.
asXml() (opens new window)	Send data formatted as XML.
attachBehavior() (opens new window)	Attaches a behavior to this component.
attachBehaviors() (opens new window)	Attaches a list of behaviors to the component.
beforeAction()	This method is invoked right before an action is executed.
behaviors() (opens new window)	Returns a list of behaviors that this component should behave as.
bindActionParams() (opens new window)	Binds the parameters to the action.
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.
createAction() (opens new window)	Creates an action based on the given action ID.
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.
findLayoutFile() (opens new window)	Finds the applicable layout file.
getBehavior() (opens new window)	Returns the named behavior object.
getBehaviors() (opens new window)	Returns all behaviors attached to this component.
getElementQuery()	Returns the element query that’s defining which elements will be returned in the current request.
getModules() (opens new window)	Returns all ancestor modules of this controller.
getRoute() (opens new window)	Returns the route of the current request.
getUniqueId() (opens new window)	Returns the unique ID of the controller.
getView()	Returns the view object that can be used to render views or view files
getViewPath() (opens new window)	Returns the directory containing view files for this controller.
goBack() (opens new window)	Redirects the browser to the last visited page.
goHome() (opens new window)	Redirects the browser to the home page.
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()	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.
redirect()	Redirects the browser to the specified URL.
redirectToPostedUrl()	Redirects to the URI specified in the POST.
refresh() (opens new window)	Refreshes the current page.
render() (opens new window)	Renders a view and applies layout if available.
renderAjax() (opens new window)	Renders a view in response to an AJAX request.
renderContent() (opens new window)	Renders a static string by applying a layout.
renderFile() (opens new window)	Renders a view file.
renderPartial() (opens new window)	Renders a view without applying layout.
renderTemplate()	Renders a template.
requireAcceptsJson()	Throws a 400 error if the request doesn't accept JSON.
requireAdmin()	Throws a 403 error if the current user is not an admin.
requireAuthorization()	Checks whether the current user can perform a given action, and ends the request with a 403 error if they don’t.
requireCpRequest()	Throws a 400 error if the current request isn’t a control panel request.
requireElevatedSession()	Requires that the user has an elevated session.
requireGuest()	Redirects the user to the account template if they are logged in.
requireLogin()	Redirects the user to the login template if they're not logged in.
requirePermission()	Checks whether the current user has a given permission, and ends the request with a 403 error if they don’t.
requirePostRequest()	Throws a 400 error if this isn’t a POST request
requireSiteRequest()	Throws a 400 error if the current request isn’t a site request.
requireToken()	Throws a 400 error if the current request doesn’t have a valid Craft token.
run() (opens new window)	Runs a request specified in terms of a route.
runAction() (opens new window)	Runs an action within this controller with the specified action ID and parameters.
setFailFlash()	Sets an error flash message on the user session.
setSuccessFlash()	Sets a success flash message on the user session.
setView() (opens new window)	Sets the view object to be used by this controller.
setViewPath() (opens new window)	Sets the directory that contains the view files.
trigger() (opens new window)	Triggers an event.

# `actionCountElements()`

Since: 3.4.6

Returns the total number of elements that match the current criteria.

View source (opens new window)

Returns

yii\web\Response (opens new window)

# `actionExport()`

Since: 3.4.4

Exports element data.

View source (opens new window)

Returns

yii\web\Response (opens new window)

Throws

yii\web\BadRequestHttpException (opens new window)

# `actionGetElements()`

Renders and returns an element index container, plus its first batch of elements.

View source (opens new window)

Returns

yii\web\Response (opens new window)

# `actionGetMoreElements()`

Renders and returns a subsequent batch of elements for an element index.

View source (opens new window)

Returns

yii\web\Response (opens new window)

# `actionGetSourceTreeHtml()`

Returns the source tree HTML for an element index.

View source (opens new window)

Returns

yii\web\Response (opens new window)

# `actionPerformAction()`

Performs an action on one or more selected elements.

View source (opens new window)

Returns

yii\web\Response (opens new window)

Throws

yii\web\BadRequestHttpException (opens new window)
if the requested element action is not supported by the element type, or its parameters didn’t validate

# `actionSourcePath()`

Since: 3.8.12

Returns the source path for the given source key, step key, and context.

View source (opens new window)

# `beforeAction()`

This method is invoked right before an action is executed.

The method will trigger the EVENT_BEFORE_ACTION (opens new window) event. The return value of the method will determine whether the action should continue to run.

In case the action should not run, the request should be handled inside of the beforeAction code by either providing the necessary output or redirecting the request. Otherwise the response will be empty.

If you override this method, your code should look like the following:

public function beforeAction($action)
{
    // your custom code here, if you want the code to run before action filters,
    // which are triggered on the [EVENT_BEFORE_ACTION](https://www.yiiframework.com/doc/api/2.0/yii-base-controller#EVENT_BEFORE_ACTION-detail) event, e.g. PageCache or AccessControl

    if (!parent::beforeAction($action)) {
        return false;
    }

    // other custom code here

    return true; // or false to not run the action
}

View source (opens new window)

Arguments

$action (yii\base\Action (opens new window)) – The action to be executed.

Returns

boolean (opens new window) – Whether the action should continue to run.

Throws

yii\web\BadRequestHttpException (opens new window)
if the request is missing a valid CSRF token
yii\web\ForbiddenHttpException (opens new window)
if the user is not logged in or lacks the necessary permissions
craft\web\ServiceUnavailableHttpException
if the system is offline and the user isn't allowed to access it
yii\web\UnauthorizedHttpException (opens new window)

# `getElementQuery()`

Returns the element query that’s defining which elements will be returned in the current request.

Other components can fetch this like so:

$criteria = Craft::$app->controller->getElementQuery();

View source (opens new window)

Returns

craft\elements\db\ElementQueryInterface

# Protected Methods

Method	Description
actionData()	Returns the data for the available actions.
availableActions()	Returns the available actions for the current source.
availableExporters()	Returns the available exporters for the current source.
bindInjectedParams() (opens new window)	Fills parameters based on types and names in action method signature.
context()	Returns the context that this controller is being called in.
elementQuery()	Returns the element query based on the current params.
elementResponseData()	Returns the element data to be returned to the client.
elementType()	Returns the posted element type class.
exporterData()	Returns the data for the available exporters.
includeActions()	Identify whether index actions should be included in the element index
source()	Returns the selected source info.
viewState()	Returns the current view state.

# `actionData()`

Returns the data for the available actions.

View source (opens new window)

Returns

array (opens new window), null (opens new window)

# `availableActions()`

Returns the available actions for the current source.

View source (opens new window)

Returns

craft\base\ElementActionInterface[], null (opens new window)

# `availableExporters()`

Since: 3.4.0

Returns the available exporters for the current source.

View source (opens new window)

Returns

craft\base\ElementExporterInterface[], null (opens new window)

# `elementQuery()`

Returns the element query based on the current params.

View source (opens new window)

Returns

craft\elements\db\ElementQueryInterface

# `elementResponseData()`

Returns the element data to be returned to the client.

View source (opens new window)

Arguments

$includeContainer (boolean (opens new window)) – Whether the element container should be included in the response data
$includeActions (boolean (opens new window)) – Whether info about the available actions should be included in the response data

Returns

array (opens new window)

# `exporterData()`

Since: 3.4.0

Returns the data for the available exporters.

View source (opens new window)

Returns

array (opens new window), null (opens new window)

# `includeActions()`

Identify whether index actions should be included in the element index

View source (opens new window)

Returns

boolean (opens new window)

# `source()`

Returns the selected source info.

View source (opens new window)

Returns

array (opens new window), null (opens new window)

Throws

yii\web\ForbiddenHttpException (opens new window)
if the user is not permitted to access the requested source

# `viewState()`

Returns the current view state.

View source (opens new window)

Returns

array (opens new window)

# Constants

Constant	Description
`ALLOW_ANONYMOUS_LIVE`
`ALLOW_ANONYMOUS_NEVER`
`ALLOW_ANONYMOUS_OFFLINE`

← ElementIndexSettingsController ElementsController →

ElementIndexesController

# Public Properties

# Protected Properties

# actions

# context

# elementQuery

# elementType

# exporters

# paginated

# source

# sourceKey

# viewState

# Public Methods

# actionCountElements()

Returns

# actionExport()

Returns

Throws

# actionGetElements()

Returns

# actionGetMoreElements()

Returns

# actionGetSourceTreeHtml()

Returns

# actionPerformAction()

Returns

Throws

# actionSourcePath()

# beforeAction()

Arguments

Returns

Throws

# getElementQuery()

Returns

# Protected Methods

# actionData()

Returns

# availableActions()

Returns

# availableExporters()

Returns

# elementQuery()

Returns

# elementResponseData()

Arguments

Returns

# exporterData()

Returns

# includeActions()

Returns

# source()

Returns

Throws

# viewState()

Returns

# Constants

# `actions`

# `context`

# `elementQuery`

# `elementType`

# `exporters`

# `paginated`

# `source`

# `sourceKey`

# `viewState`

# `actionCountElements()`

# `actionExport()`

# `actionGetElements()`

# `actionGetMoreElements()`

# `actionGetSourceTreeHtml()`

# `actionPerformAction()`

# `actionSourcePath()`

# `beforeAction()`

# `getElementQuery()`

# `actionData()`

# `availableActions()`

# `availableExporters()`

# `elementQuery()`

# `elementResponseData()`

# `exporterData()`

# `includeActions()`

# `source()`

# `viewState()`