Craft 5 Class Reference

Appearance

Controller ​

Type
Abstract Class
Namespace
craft\web
Inherits
craft\web\Controller » yii\web\Controller » yii\base\Controller » yii\base\Component » yii\base\BaseObject
Implements
yii\base\Configurable, yii\base\ViewContextInterface
Extended by
craft\controllers\AddressesController, craft\controllers\AppController, craft\controllers\AssetIndexesController, craft\controllers\AssetsController, craft\controllers\AuthController, craft\controllers\BaseElementsController, craft\controllers\BaseEntriesController, craft\controllers\BaseUpdaterController, craft\controllers\CategoriesController, craft\controllers\ChartsController, craft\controllers\ConditionsController, craft\controllers\ConfigSyncController, craft\controllers\DashboardController, craft\controllers\ElementIndexSettingsController, craft\controllers\ElementIndexesController, craft\controllers\ElementSelectorModalsController, craft\controllers\ElementsController, craft\controllers\EntriesController, craft\controllers\EntryTypesController, craft\controllers\FieldsController, craft\controllers\FsController, craft\controllers\GlobalsController, craft\controllers\GraphqlController, craft\controllers\ImageTransformsController, craft\controllers\InstallController, craft\controllers\LivePreviewController, craft\controllers\MatrixController, craft\controllers\NestedElementsController, craft\controllers\NotFoundController, craft\controllers\PluginStoreController, craft\controllers\PluginsController, craft\controllers\PreviewController, craft\controllers\ProjectConfigController, craft\controllers\QueueController, craft\controllers\RebrandController, craft\controllers\RedirectController, craft\controllers\RelationalFieldsController, craft\controllers\RoutesController, craft\controllers\SectionsController, craft\controllers\SitesController, craft\controllers\SsoController, craft\controllers\StructuresController, craft\controllers\SystemMessagesController, craft\controllers\SystemSettingsController, craft\controllers\TagsController, craft\controllers\TemplatesController, craft\controllers\UpdaterController, craft\controllers\UserSettingsController, craft\controllers\UsersController, craft\controllers\UtilitiesController, craft\controllers\VolumesController, craft\controllers\pluginstore\InstallController, craft\controllers\pluginstore\RemoveController, craft\test\mockclasses\controllers\TestController
Since
3.0.0

Controller is a base class that all controllers in Craft extend.

It extends Yii’s yii\web\Controller, overwriting specific methods as required.

View source

Public Properties ​

PropertyDescription
actionyii\base\Action, null – The action that is currently being executed.
actionParamsarray – The parameters bound to the current action.
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.
layoutstring, null, 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.
requestcraft\web\Request
responsecraft\web\Response
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).
viewcraft\web\View – The view object that can be used to render views or view files
viewPathstring – The directory containing the view files for this controller.

request ​

Type
craft\web\Request
Default value
null

View source

response ​

Type
craft\web\Response
Default value
null

View source

view ​

Type
craft\web\View
Default value
null

The view object that can be used to render views or view files

View source

Protected Properties ​

PropertyDescription
allowAnonymousinteger, boolean, integer[], string[] – Whether this controller’s actions can be accessed anonymously.

allowAnonymous ​

Type
integer, boolean, integer[], string[]
Default value
self::ALLOW_ANONYMOUS_NEVER

Whether this controller’s actions can be accessed anonymously.

This can be set to any of the following:

  • false or self::ALLOW_ANONYMOUS_NEVER (default) – indicates that all controller actions should never be accessed anonymously
  • true or self::ALLOW_ANONYMOUS_LIVE – indicates that all controller actions can be accessed anonymously when the system is live
  • self::ALLOW_ANONYMOUS_OFFLINE – indicates that all controller actions can be accessed anonymously when the system is offline
  • self::ALLOW_ANONYMOUS_LIVE | self::ALLOW_ANONYMOUS_OFFLINE – indicates that all controller actions can be accessed anonymously when the system is live or offline
  • An array of action IDs (e.g. ['save-guest-entry', 'edit-guest-entry']) – indicates that the listed action IDs can be accessed anonymously when the system is live
  • An array of action ID/bitwise pairs (e.g. ['save-guest-entry' => self::ALLOW_ANONYMOUS_OFFLINE] – indicates that the listed action IDs can be accessed anonymously per the bitwise int assigned to it.

View source

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()
__get()Returns the value of a component property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets the value of a component property.
__unset()Sets a component property to be null.
actions()Declares external actions for the controller.
afterAction()This method is invoked right after an action is executed.
asCpModal()Sends a control panel modal response.
asCpScreen()Sends a control panel screen response.
asErrorJson()Responds to the request with a JSON error message.
asFailure()Sends a failure response.
asJson()Send data formatted as JSON.
asJsonP()Sets the response format of the given data as JSONP.
asModelFailure()Sends a failure response for a model.
asModelSuccess()Sends a success response for a model.
asRaw()Sets the response format of the given data as RAW.
asSuccess()Sends a success response.
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.
currentUser()Returns the currently logged-in user.
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()Returns the directory containing view files for this controller.
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 for this component.
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()Sends a rendered template response.
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()Runs a request specified in terms of a route.
runAction()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()Sets the view object to be used by this controller.
setViewPath()Sets the directory that contains the view files.
trigger()Triggers an event.

asCpModal() ​

Since
5.0.0

Sends a control panel modal response.

View source

Returns ​

craft\web\Response

asCpScreen() ​

Since
4.0.0

Sends a control panel screen response.

View source

Returns ​

craft\web\Response

asErrorJson() ​

DEPRECATED

Deprecated in 4.0.0. asFailure() should be used instead.

Responds to the request with a JSON error message.

View source

Arguments ​

  • $error (string) – The error message.

Returns ​

yii\web\Response

asFailure() ​

Since
4.0.0

Sends a failure response.

View source

Arguments ​

  • $message (string, null)
  • $data (array) – Additional data to include in the JSON response
  • $routeParams (array) – The route params to send back to the template

Returns ​

yii\web\Response, null

asJsonP() ​

Sets the response format of the given data as JSONP.

See also:

View source

Arguments ​

  • $data (mixed) – The data that should be formatted.

Returns ​

yii\web\Response – A response that is configured to send $data formatted as JSON.

asModelFailure() ​

Since
4.0.0

Sends a failure response for a model.

View source

Arguments ​

  • $model (yii\base\Model, craft\base\ModelInterface) – The model that was being operated on
  • $message (string, null)
  • $modelName (string, null) – The route param name that the model should be set to
  • $data (array) – Additional data to include in the JSON response
  • $routeParams (array) – Additional route params that should be set for the next controller action

Returns ​

yii\web\Response, null

asModelSuccess() ​

Since
4.0.0

Sends a success response for a model.

View source

Arguments ​

Returns ​

yii\web\Response

asRaw() ​

Sets the response format of the given data as RAW.

See also:

View source

Arguments ​

  • $data (mixed) – The data that should not be formatted.

Returns ​

yii\web\Response – A response that is configured to send $data without formatting.

asSuccess() ​

Since
4.0.0

Sends a success response.

View source

Arguments ​

  • $message (string, null)
  • $data (array) – Additional data to include in the JSON response
  • $redirect (string, null) – The URL to redirect the request
  • $notificationSettings (array) – Control panel notification settings

Returns ​

yii\web\Response, null

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:

php
public function beforeAction($action): bool
{
    // 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.

Throws ​

behaviors() ​

Returns a list of behaviors that this component should behave as.

Child classes may override this method to specify the behaviors they want to behave as.

The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:

php
'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

Note that a behavior class must extend from \craft\web\Behavior. Behaviors can be attached using a name or anonymously. When a name is used as the array key, using this name, the behavior can later be retrieved using getBehavior() or be detached using detachBehavior(). Anonymous behaviors can not be retrieved or detached.

Behaviors declared in this method will be attached to the component automatically (on demand).

View source

Returns ​

array – The behavior configurations.

currentUser() ​

Since
4.3.0

Returns the currently logged-in user.

See also yii\web\User::getIdentity()View source

Arguments ​

Returns ​

craft\elements\User, null

getView() ​

Returns the view object that can be used to render views or view files

View source

Returns ​

craft\web\View –

init() ​

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

View source

Throws ​

redirect() ​

Redirects the browser to the specified URL.

This method is a shortcut to craft\web\Response::redirect().

You can use it in an action by returning the craft\web\Response directly:

php
// stop executing this action and redirect to login page
return $this->redirect(['login']);

View source

Arguments ​

  • $url (string, array, null) – The URL to be redirected to. This can be in one of the following formats:

  • a string representing a URL (e.g. "https://example.com")

  • a string representing a URL alias (e.g. "@example.com")

  • an array in the format of [$route, ...name-value pairs...] (e.g. ['site/index', 'ref' => 1]) yii\helpers\Url::to() will be used to convert the array into a URL.

Any relative URL that starts with a single forward slash "/" will be converted into an absolute one by prepending it with the host info of the current request.

Returns ​

yii\web\Response – The current response object

redirectToPostedUrl() ​

Redirects to the URI specified in the POST.

View source

Arguments ​

  • $object (object, null) – Object containing properties that should be parsed for in the URL.
  • $default (string, null) – The default URL to redirect them to, if no 'redirect' parameter exists. If this is left null, then the current request’s path will be used.

Returns ​

yii\web\Response

Throws ​

renderTemplate() ​

Sends a rendered template response.

View source

Arguments ​

  • $template (string) – The name of the template to load
  • $variables (array) – The variables that should be available to the template
  • $templateMode (string, null) – The template mode to use

Returns ​

yii\web\Response

Throws ​

requireAcceptsJson() ​

Throws a 400 error if the request doesn't accept JSON.

View source

Throws ​

requireAdmin() ​

Throws a 403 error if the current user is not an admin.

View source

Arguments ​

Throws ​

requireAuthorization() ​

Checks whether the current user can perform a given action, and ends the request with a 403 error if they don’t.

View source

Arguments ​

  • $action (string) – The name of the action to check.

Throws ​

requireCpRequest() ​

Since
3.1.0

Throws a 400 error if the current request isn’t a control panel request.

View source

Throws ​

requireElevatedSession() ​

Requires that the user has an elevated session.

View source

Throws ​

requireGuest() ​

Since
3.4.0

Redirects the user to the account template if they are logged in.

View source

requireLogin() ​

Redirects the user to the login template if they're not logged in.

View source

requirePermission() ​

Checks whether the current user has a given permission, and ends the request with a 403 error if they don’t.

View source

Arguments ​

  • $permissionName (string) – The name of the permission.

Throws ​

requirePostRequest() ​

Throws a 400 error if this isn’t a POST request

View source

Throws ​

requireSiteRequest() ​

Since
3.1.0

Throws a 400 error if the current request isn’t a site request.

View source

Throws ​

requireToken() ​

Throws a 400 error if the current request doesn’t have a valid Craft token.

See also craft\web\Request::getToken()View source

Throws ​

setFailFlash() ​

Since
3.5.0

Sets an error flash message on the user session.

If a hashed failMessage param was sent with the request, that will be used instead of the provided default.

View source

Arguments ​

  • $default (string, null) – The default message, if no successMessage param was sent
  • $settings (array) – Control panel notification settings

setSuccessFlash() ​

Since
3.5.0

Sets a success flash message on the user session.

If a hashed successMessage param was sent with the request, that will be used instead of the provided default.

View source

Arguments ​

  • $default (string, null) – The default message, if no successMessage param was sent
  • $settings (array) – Control panel notification settings

Protected Methods ​

MethodDescription
bindInjectedParams()Fills parameters based on types and names in action method signature.
defineBehaviors()Returns the behaviors to attach to this class.
getPostedRedirectUrl()Gets the redirect param specified in the POST data.

defineBehaviors() ​

Since
4.5.0

Returns the behaviors to attach to this class.

See behaviors() for details about what should be returned.

Controllers should override this method instead of behaviors() so EVENT_DEFINE_BEHAVIORS handlers can modify the class-defined behaviors.

View source

Returns ​

array

getPostedRedirectUrl() ​

Since
4.0.0

Gets the redirect param specified in the POST data.

View source

Arguments ​

  • $object (object, null) – Object containing properties that should be parsed for in the URL.

Returns ​

string, null

Throws ​

Constants ​

ConstantDescription
ALLOW_ANONYMOUS_LIVE
ALLOW_ANONYMOUS_NEVER
ALLOW_ANONYMOUS_OFFLINE

Events ​

EVENT_DEFINE_BEHAVIORS ​

Type
craft\events\DefineBehaviorsEvent
Since
4.5.0

The event that is triggered when defining the class behaviors

See also behaviors()