Controller is the base class for classes containing controller logic.
For more details and usage information on Controller, see the guide article on controllers.
Property | Type | Description | Defined By |
---|---|---|---|
$action | yii\base\Action | The action that is currently being executed. | yii\base\Controller |
$behaviors | yii\base\Behavior[] | List of behaviors attached to this component | yii\base\Component |
$defaultAction | string | The ID of the action that is used when the action ID is not specified in the request. | yii\base\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 |
$modules | yii\base\Module[] | All ancestor modules that this controller is located within. | yii\base\Controller |
$route | string | The route (module ID, controller ID and action ID) of the current request. | yii\base\Controller |
$uniqueId | string | The controller ID that is prefixed with the module ID (if any). | yii\base\Controller |
$view | yii\base\View|yii\web\View | The view object that can be used to render views or view files. | yii\base\Controller |
$viewPath | string | The directory containing the view files for this controller. | yii\base\Controller |
Method | Description | Defined By |
---|---|---|
__call() | Calls the named method which is not a class method. | yii\base\Object |
__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 an object property. | yii\base\Object |
__isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Object |
__set() | Sets value of an object property. | yii\base\Object |
__unset() | Sets an object property to null. | yii\base\Object |
actions() | Declares external actions for the controller. | yii\base\Controller |
afterAction() | This method is invoked right after an action is executed. | yii\base\Controller |
attachBehavior() | Attaches a behavior to this component. | yii\base\Component |
attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component |
beforeAction() | This method is invoked right before an action is executed. | yii\base\Controller |
behaviors() | Returns a list of behaviors that this component should behave as. | yii\base\Component |
bindActionParams() | Binds the parameters to the action. | yii\base\Controller |
canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Object |
canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Object |
className() | Returns the fully qualified name of this class. | yii\base\Object |
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 |
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\Object |
hasProperty() | Returns a value indicating whether a property is defined. | yii\base\Object |
init() | Initializes the object. | yii\base\Object |
off() | Detaches an existing event handler from this component. | yii\base\Component |
on() | Attaches an event handler to an event. | yii\base\Component |
render() | Renders a view and applies layout if available. | yii\base\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 |
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 |
The action that is currently being executed. This property will be set by run() when it is called by yii\base\Application to run an action.
public yii\base\Action $action = null
The ID of the action that is used when the action ID is not specified in the request. Defaults to 'index'.
public string $defaultAction = 'index'
The ID of this controller.
public string $id = null
The name of the layout to be applied to this controller's views. This property mainly affects the behavior of render(). Defaults to null, meaning the actual layout value should inherit that from $module's layout value. If false, no layout will be applied.
public null|string|false $layout = null
The module that this controller belongs to.
public yii\base\Module $module = null
All ancestor modules that this controller is located within.
public yii\base\Module[] getModules ( )
The route (module ID, controller ID and action ID) of the current request.
public string getRoute ( )
The controller ID that is prefixed with the module ID (if any).
public string getUniqueId ( )
The view object that can be used to render views or view files.
public yii\base\View|yii\web\View getView ( )
public void setView ( $view )
The directory containing the view files for this controller.
public string getViewPath ( )
public void setViewPath ( $path )
public void __construct ( $id, $module, $config = [] ) | ||
---|---|---|
$id | string |
The ID of this controller. |
$module | yii\base\Module |
The module that this controller belongs to. |
$config | array |
Name-value pairs that will be used to initialize the object properties. |
Declares external actions for the controller.
This method is meant to be overwritten to declare external actions for the controller. It should return an array, with array keys being action IDs, and array values the corresponding action class names or action configuration arrays. For example,
return [ 'action1' => 'app\components\Action1', 'action2' => [ 'class' => 'app\components\Action2', 'property1' => 'value1', 'property2' => 'value2', ], ];
Yii::createObject() will be used later to create the requested action using the configuration provided here.
public void actions ( ) |
---|
This method is invoked right after an action is executed.
The method will trigger the EVENT_AFTER_ACTION event. The return value of the method will be used as the action return value.
If you override this method, your code should look like the following:
public function afterAction($action, $result) { $result = parent::afterAction($action, $result); // your custom code here return $result; }
public mixed afterAction ( $action, $result ) | ||
---|---|---|
$action | yii\base\Action |
The action just executed. |
$result | mixed |
The action return result. |
return | mixed |
The processed action result. |
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]] 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 }
public boolean beforeAction ( $action ) | ||
---|---|---|
$action | yii\base\Action |
The action to be executed. |
return | boolean |
Whether the action should continue to run. |
Binds the parameters to the action.
This method is invoked by yii\base\Action when it begins to run with the given parameters.
public array bindActionParams ( $action, $params ) | ||
---|---|---|
$action | yii\base\Action |
The action to be bound with parameters. |
$params | array |
The parameters to be bound to the action. |
return | array |
The valid parameters that the action can run with. |
Creates an action based on the given action ID.
The method first checks if the action ID has been declared in actions(). If so, it will use the configuration declared there to create the action object. If not, it will look for a controller method whose name is in the format of actionXyz
where Xyz
stands for the action ID. If found, an yii\base\InlineAction representing that method will be created and returned.
public yii\base\Action|null createAction ( $id ) | ||
---|---|---|
$id | string |
The action ID. |
return | yii\base\Action|null |
The newly created action instance. Null if the ID doesn't resolve into any action. |
Finds the applicable layout file.
public string|boolean findLayoutFile ( $view ) | ||
---|---|---|
$view | yii\base\View |
The view object to render the layout file. |
return | string|boolean |
The layout file path, or false if layout is not needed. Please refer to render() on how to specify this parameter. |
throws | yii\base\InvalidParamException |
if an invalid path alias is used to specify the layout. |
Returns all ancestor modules of this controller.
The first module in the array is the outermost one (i.e., the application instance), while the last is the innermost one.
public yii\base\Module[] getModules ( ) | ||
---|---|---|
return | yii\base\Module[] |
All ancestor modules that this controller is located within. |
Returns the route of the current request.
public string getRoute ( ) | ||
---|---|---|
return | string |
The route (module ID, controller ID and action ID) of the current request. |
Returns the unique ID of the controller.
public string getUniqueId ( ) | ||
---|---|---|
return | string |
The controller ID that is prefixed with the module ID (if any). |
Returns the view object that can be used to render views or view files.
The render(), renderPartial() and renderFile() methods will use this view object to implement the actual view rendering. If not set, it will default to the "view" application component.
public yii\base\View|yii\web\View getView ( ) | ||
---|---|---|
return | yii\base\View|yii\web\View |
The view object that can be used to render views or view files. |
Returns the directory containing view files for this controller.
The default implementation returns the directory named as controller $id under the $module's $viewPath directory.
public string getViewPath ( ) | ||
---|---|---|
return | string |
The directory containing the view files for this controller. |
Renders a view and applies layout if available.
The view to be rendered can be specified in one of the following formats:
To determine which layout should be applied, the following two steps are conducted:
If the layout name does not contain a file extension, it will use the default one .php
.
public string render ( $view, $params = [] ) | ||
---|---|---|
$view | string |
The view name. |
$params | array |
The parameters (name-value pairs) that should be made available in the view. These parameters will not be available in the layout. |
return | string |
The rendering result. |
throws | yii\base\InvalidParamException |
if the view file or the layout file does not exist. |
Renders a static string by applying a layout.
public string renderContent ( $content ) | ||
---|---|---|
$content | string |
The static string being rendered |
return | string |
The rendering result of the layout with the given static string as the |
Renders a view file.
public string renderFile ( $file, $params = [] ) | ||
---|---|---|
$file | string |
The view file to be rendered. This can be either a file path or a path alias. |
$params | array |
The parameters (name-value pairs) that should be made available in the view. |
return | string |
The rendering result. |
throws | yii\base\InvalidParamException |
if the view file does not exist. |
Renders a view without applying layout.
This method differs from render() in that it does not apply any layout.
public string renderPartial ( $view, $params = [] ) | ||
---|---|---|
$view | string |
The view name. Please refer to render() on how to specify a view name. |
$params | array |
The parameters (name-value pairs) that should be made available in the view. |
return | string |
The rendering result. |
throws | yii\base\InvalidParamException |
if the view file does not exist. |
Runs a request specified in terms of a route.
The route can be either an ID of an action within this controller or a complete route consisting of module IDs, controller ID and action ID. If the route starts with a slash '/', the parsing of the route will start from the application; otherwise, it will start from the parent module of this controller.
See also runAction().
public mixed run ( $route, $params = [] ) | ||
---|---|---|
$route | string |
The route to be handled, e.g., 'view', 'comment/view', '/admin/comment/view'. |
$params | array |
The parameters to be passed to the action. |
return | mixed |
The result of the action. |
Runs an action within this controller with the specified action ID and parameters.
If the action ID is empty, the method will use $defaultAction.
See also createAction().
public mixed runAction ( $id, $params = [] ) | ||
---|---|---|
$id | string |
The ID of the action to be executed. |
$params | array |
The parameters (name-value pairs) to be passed to the action. |
return | mixed |
The result of the action. |
throws | yii\base\InvalidRouteException |
if the requested action ID cannot be resolved into an action successfully. |
Sets the view object to be used by this controller.
public void setView ( $view ) | ||
---|---|---|
$view | yii\base\View|yii\web\View |
The view object that can be used to render views or view files. |
Sets the directory that contains the view files.
public void setViewPath ( $path ) | ||
---|---|---|
$path | string |
The root directory of view files. |
throws | yii\base\InvalidParamException |
if the directory is invalid |
An event raised right after executing a controller action.
An event raised right before executing a controller action. You may set yii\base\ActionEvent::$isValid to be false to cancel the action execution.
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-base-controller.html