UtilitiesController
- Type
- Class
- Namespace
- craft\controllers
- Inherits
- craft\controllers\UtilitiesController » 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)
View source (opens new window)
# 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 |
|---|---|
| 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. |
# 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. |
| actionApplyNewMigrations() | Applies new migrations |
| actionClearCachesPerformAction() | Performs a Clear Caches action |
| actionDbBackupPerformAction() | Performs a DB Backup action |
| actionDeleteAllDeprecationErrors() | Deletes all deprecation warnings. |
| actionDeleteDeprecationError() | Deletes a deprecation error. |
| actionFindAndReplacePerformAction() | Performs a Find And Replace action |
| actionGetDeprecationErrorTracesModal() | View stack trace for a deprecator log entry. |
| actionIndex() | Index |
| actionInvalidateTags() | Performs an Invalidate Data Caches action. |
| actionShowUtility() | Show a utility page. |
| actions() (opens new window) | Declares external actions for the controller. |
| afterAction() (opens new window) | This method is invoked right after an action is executed. |
| asCpScreen() | Sends a control panel screen response. |
| asErrorJson() | Responds to the request with a JSON error message. |
| asFailure() | Sends a failure response. |
| asJson() (opens new window) | 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() (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. |
| currentUser() | Returns the currently logged-in user. |
| 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. |
| 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() | 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() (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. |
# actionApplyNewMigrations()
Applies new migrations
View source (opens new window)
Returns
yii\web\Response (opens new window)
Throws
- yii\web\ForbiddenHttpException (opens new window)
if the user doesn’t have access to the Migrations utility
# actionClearCachesPerformAction()
Performs a Clear Caches action
View source (opens new window)
Returns
yii\web\Response (opens new window)
Throws
- yii\web\ForbiddenHttpException (opens new window)
if the user doesn’t have access to the Clear Caches utility - yii\web\BadRequestHttpException (opens new window)
# actionDbBackupPerformAction()
Performs a DB Backup action
View source (opens new window)
Returns
yii\web\Response (opens new window), null (opens new window)
Throws
- yii\web\ForbiddenHttpException (opens new window)
if the user doesn’t have access to the DB Backup utility - yii\base\Exception (opens new window)
if the backup could not be created
# actionDeleteAllDeprecationErrors()
Deletes all deprecation warnings.
View source (opens new window)
Returns
yii\web\Response (opens new window)
Throws
- yii\web\ForbiddenHttpException (opens new window)
if the user doesn’t have access to the Deprecation Warnings utility
# actionDeleteDeprecationError()
Deletes a deprecation error.
View source (opens new window)
Returns
yii\web\Response (opens new window)
Throws
- yii\web\ForbiddenHttpException (opens new window)
if the user doesn’t have access to the Deprecation Warnings utility
# actionFindAndReplacePerformAction()
Performs a Find And Replace action
View source (opens new window)
Returns
yii\web\Response (opens new window)
Throws
- yii\web\ForbiddenHttpException (opens new window)
if the user doesn’t have access to the Find and Replace utility
# actionGetDeprecationErrorTracesModal()
View stack trace for a deprecator log entry.
View source (opens new window)
Returns
yii\web\Response (opens new window)
Throws
- yii\web\ForbiddenHttpException (opens new window)
if the user doesn’t have access to the Deprecation Warnings utility
# actionIndex()
Index
View source (opens new window)
Returns
yii\web\Response (opens new window)
Throws
- yii\web\ForbiddenHttpException (opens new window)
if the user doesn’t have access to any utilities
# actionInvalidateTags()
- Since
- 3.5.0
Performs an Invalidate Data Caches action.
View source (opens new window)
Returns
yii\web\Response (opens new window)
Throws
- yii\web\ForbiddenHttpException (opens new window)
if the user doesn’t have access to the Clear Caches utility - yii\web\BadRequestHttpException (opens new window)
# actionShowUtility()
Show a utility page.
View source (opens new window)
Arguments
Returns
yii\web\Response (opens new window)
Throws
- yii\web\NotFoundHttpException (opens new window)
if $id is invalid - yii\web\ForbiddenHttpException (opens new window)
if the user doesn’t have access to the requested utility - yii\base\Exception (opens new window)
in case of failure
# Protected Methods
| Method | Description |
|---|---|
| bindInjectedParams() (opens new window) | Fills parameters based on types and names in action method signature. |
| getPostedRedirectUrl() | Gets the redirect param specified in the POST data. |
# Constants
| Constant | Description |
|---|---|
ALLOW_ANONYMOUS_LIVE | |
ALLOW_ANONYMOUS_NEVER | |
ALLOW_ANONYMOUS_OFFLINE |