AppController

Type
Class
Namespace
craft\controllers
Inherits
craft\controllers\AppController » craft\web\Controller » yii\web\Controller » yii\base\Controller » yii\base\Component » yii\base\BaseObject
Implements
yii\base\Configurable, yii\base\ViewContextInterface
Since
3.0

The AppController class is a controller that handles various actions for Craft updates, control panel requests, upgrading Craft editions and license requests.

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

View source

Public Properties

PropertyDescription
$actionyii\base\Action – The action that is currently being executed.
$actionParamsarray – The parameters bound to the current action.
$allowAnonymousboolean, string[] – Whether this controller’s actions can be accessed anonymously If set to false, you are required to be logged in to execute any of the given controller's actions.
$behaviorsyii\base\Behavior – List of behaviors attached to this component
$defaultActionstring – The ID of the action that is used when the action ID is not specified in the request.
$enableCsrfValidationboolean – Whether to enable CSRF validation for the actions in this controller.
$idstring – The ID of this controller.
$layoutnull, string, false – The name of the layout to be applied to this controller's views.
$moduleyii\base\Module – The module that this controller belongs to.
$modulesyii\base\Module – All ancestor modules that this controller is located within.
$routestring – The route (module ID, controller ID and action ID) of the current request.
$uniqueIdstring – The controller ID that is prefixed with the module ID (if any).
$viewyii\base\View, yii\web\View – The view object that can be used to render views or view files.
$viewPathstring – The view path that may be prefixed to a relative view name.

$allowAnonymous

Type
boolean, string[]

Whether this controller’s actions can be accessed anonymously If set to false, you are required to be logged in to execute any of the given controller's actions. If set to true, anonymous access is allowed for all of the given controller's actions. If the value is an array of action IDs, then you must be logged in for any actions except for the ones in the array list. If you have a controller that where the majority of actions allow anonymous access, but you only want require login on a few, you can set this to true and call requireLogin() in the individual methods.

View source

Signature

public boolean, string[] $allowAnonymous = ['migrate']

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 an object property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets value of an object property.
__unset()Sets an object property to null.
actionCheckForUpdates()Returns update info.
actionGetCpAlerts()Loads any CP alerts.
actionGetPluginLicenseInfo()Fetches plugin license statuses.
actionGetUtilitiesBadgeCount()Returns the badge count for the Utilities nav item.
actionMigrate()Creates a DB backup (if configured to do so) and runs any pending Craft, plugin, & content migrations in one go.
actionShunCpAlert()Shuns a CP alert for 24 hours.
actionSwitchToLicensedEdition()Switches Craft to the edition it's licensed for.
actionTryEdition()Tries a Craft edition on for size.
actionUpdatePluginLicense()Updates a plugin's license key.
actions()Declares external actions for the controller.
afterAction()This method is invoked right after an action is executed.
asErrorJson()Responds to the request with a JSON error message.
asJson()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()Send data formatted as XML.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
beforeAction()This method is invoked right before an action is executed.
behaviors()Returns a list of behaviors that this component should behave as.
bindActionParams()Binds the parameters to the action.
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.
createAction()Creates an action based on the given action ID.
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.
findLayoutFile()Finds the applicable layout file.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
getModules()Returns all ancestor modules of this controller.
getRoute()Returns the route of the current request.
getUniqueId()Returns the unique ID of the controller.
getView()Returns the view object that can be used to render views or view files.
getViewPath()
goBack()Redirects the browser to the last visited page.
goHome()Redirects the browser to the home page.
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.
init()Initializes the object.
off()Detaches an existing event handler from this component.
on()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()Refreshes the current page.
render()Renders a view and applies layout if available.
renderAjax()Renders a view in response to an AJAX request.
renderContent()Renders a static string by applying a layout.
renderFile()Renders a view file.
renderPartial()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.
requireElevatedSession()Requires that the user has an elevated session.
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
requireToken()Throws a 400 error if the current request doesn’t have a valid token.
run()Runs a request specified in terms of a route.
runAction()Runs an action within this controller with the specified action ID and parameters.
setView()Sets the view object to be used by this controller.
setViewPath()Sets the directory that contains the view files.
trigger()Triggers an event.

actionCheckForUpdates()

Returns update info.

View source

Returns

yii\web\Response

Throws

Signature

public yii\web\Response actionCheckForUpdates ( )

actionGetCpAlerts()

Loads any CP alerts.

View source

Returns

yii\web\Response

Signature

public yii\web\Response actionGetCpAlerts ( )

actionGetPluginLicenseInfo()

Fetches plugin license statuses.

View source

Returns

yii\web\Response

Signature

public yii\web\Response actionGetPluginLicenseInfo ( )

actionGetUtilitiesBadgeCount()

Returns the badge count for the Utilities nav item.

View source

Returns

yii\web\Response

Signature

public yii\web\Response actionGetUtilitiesBadgeCount ( )

actionMigrate()

Creates a DB backup (if configured to do so) and runs any pending Craft, plugin, & content migrations in one go. This action can be used as a post-deploy webhook with site deployment services (like DeployBot) to minimize site downtime after a deployment.

View source

Throws

  • \Http\Client\Common\Exception\ServerErrorException
    if something went wrong

Signature

public void actionMigrate ( )

actionShunCpAlert()

Shuns a CP alert for 24 hours.

View source

Returns

yii\web\Response

Signature

public yii\web\Response actionShunCpAlert ( )

actionSwitchToLicensedEdition()

Switches Craft to the edition it's licensed for.

View source

Returns

yii\web\Response

Signature

public yii\web\Response actionSwitchToLicensedEdition ( )

actionTryEdition()

Tries a Craft edition on for size.

View source

Returns

yii\web\Response

Throws

Signature

public yii\web\Response actionTryEdition ( )

actionUpdatePluginLicense()

Updates a plugin's license key.

View source

Returns

yii\web\Response

Signature

public yii\web\Response actionUpdatePluginLicense ( )

beforeAction()

This method is invoked right before an action is executed.

The method will trigger the EVENT_BEFORE_ACTION 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

Arguments

Returns

boolean – Whether the action should continue to run.

Signature

public boolean beforeAction ( $action )