Class yii\debug\controllers\UserController
| Inheritance | yii\debug\controllers\UserController » yii\web\Controller » yii\base\Controller » yii\base\Component » yii\base\BaseObject |
|---|---|
| Implements | yii\base\Configurable, yii\base\ViewContextInterface |
| Available since version | 2.0.10 |
| Source Code | https://github.com/yiisoft/yii2-debug/blob/master/controllers/UserController.php |
User controller
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $action | yii\base\Action|null | The action that is currently being executed. | yii\base\Controller |
| $actionParams | array | The parameters bound to the current action. | yii\web\Controller |
| $defaultAction | string | The ID of the action that is used when the action ID is not specified in the request. | yii\base\Controller |
| $enableCsrfValidation | boolean | Whether to enable CSRF validation for the actions in this controller. | yii\web\Controller |
| $id | string | The ID of this controller. | yii\base\Controller |
| $layout | null|string|false | The name of the layout to be applied to this controller's views. | yii\base\Controller |
| $module | yii\base\Module | The module that this controller belongs to. | yii\base\Controller |
| $request | yii\base\Request|array|string | The request. | yii\base\Controller |
| $response | yii\base\Response|array|string | The response. | yii\base\Controller |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | yii\base\Component |
| __clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component |
| __construct() | yii\base\Controller | |
| __get() | Returns the value of a component property. | yii\base\Component |
| __isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Component |
| __set() | Sets the value of a component property. | yii\base\Component |
| __unset() | Sets a component property to be null. | yii\base\Component |
| actionResetIdentity() | Reset identity, switch to main user | yii\debug\controllers\UserController |
| actionSetIdentity() | Set new identity, switch user | yii\debug\controllers\UserController |
| actions() | Declares external actions for the controller. | yii\base\Controller |
| afterAction() | This method is invoked right after an action is executed. | yii\base\Controller |
| asJson() | Send data formatted as JSON. | yii\web\Controller |
| asXml() | Send data formatted as XML. | yii\web\Controller |
| attachBehavior() | Attaches a behavior to this component. | yii\base\Component |
| attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component |
| beforeAction() | {@inheritdoc} | yii\debug\controllers\UserController |
| behaviors() | Returns a list of behaviors that this component should behave as. | yii\base\Component |
| bindActionParams() | Binds the parameters to the action. | yii\web\Controller |
| canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Component |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Component |
| className() | Returns the fully qualified name of this class. | yii\base\BaseObject |
| createAction() | Creates an action based on the given action ID. | yii\base\Controller |
| detachBehavior() | Detaches a behavior from the component. | yii\base\Component |
| detachBehaviors() | Detaches all behaviors from the component. | yii\base\Component |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component |
| findLayoutFile() | Finds the applicable layout file. | yii\base\Controller |
| getBehavior() | Returns the named behavior object. | yii\base\Component |
| getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component |
| getModules() | Returns all ancestor modules of this controller. | yii\base\Controller |
| getRoute() | Returns the route of the current request. | yii\base\Controller |
| getUniqueId() | Returns the unique ID of the controller. | yii\base\Controller |
| getView() | Returns the view object that can be used to render views or view files. | yii\base\Controller |
| getViewPath() | Returns the directory containing view files for this controller. | yii\base\Controller |
| goBack() | Redirects the browser to the last visited page. | yii\web\Controller |
| goHome() | Redirects the browser to the home page. | yii\web\Controller |
| hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component |
| hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Component |
| hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component |
| init() | {@inheritdoc} | yii\base\Controller |
| off() | Detaches an existing event handler from this component. | yii\base\Component |
| on() | Attaches an event handler to an event. | yii\base\Component |
| redirect() | Redirects the browser to the specified URL. | yii\web\Controller |
| refresh() | Refreshes the current page. | yii\web\Controller |
| render() | Renders a view and applies layout if available. | yii\base\Controller |
| renderAjax() | Renders a view in response to an AJAX request. | yii\web\Controller |
| renderContent() | Renders a static string by applying a layout. | yii\base\Controller |
| renderFile() | Renders a view file. | yii\base\Controller |
| renderPartial() | Renders a view without applying layout. | yii\base\Controller |
| run() | Runs a request specified in terms of a route. | yii\base\Controller |
| runAction() | Runs an action within this controller with the specified action ID and parameters. | yii\base\Controller |
| setView() | Sets the view object to be used by this controller. | yii\base\Controller |
| setViewPath() | Sets the directory that contains the view files. | yii\base\Controller |
| trigger() | Triggers an event. | yii\base\Component |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| bindInjectedParams() | Fills parameters based on types and names in action method signature. | yii\base\Controller |
Events
| Event | Type | Description | Defined By |
|---|---|---|---|
| EVENT_AFTER_ACTION | yii\base\ActionEvent | An event raised right after executing a controller action. | yii\base\Controller |
| EVENT_BEFORE_ACTION | yii\base\ActionEvent | An event raised right before executing a controller action. | yii\base\Controller |
Method Details
Reset identity, switch to main user
| public yii\web\User actionResetIdentity ( ) | ||
| throws | yii\base\InvalidConfigException | |
|---|---|---|
Set new identity, switch user
| public yii\web\User actionSetIdentity ( ) | ||
| throws | yii\base\InvalidConfigException | |
|---|---|---|
{@inheritdoc}
| public void beforeAction ( $action ) | ||
| $action | ||
| throws | yii\web\BadRequestHttpException | |
|---|---|---|