public array $actionParams = []

public boolean $enableCsrfValidation = true

asJson() public method (available since version 2.0.11)

Send data formatted as JSON.

This method is a shortcut for sending data formatted as JSON. It will return the response application component after configuring the format and setting the data that should be formatted. A common usage will be:

return $this->asJson($data);

See also:

• yii\web\Response::$format
• yii\web\Response::FORMAT_JSON
• yii\web\JsonResponseFormatter

public yii\web\Response asJson ( $data )
$data	mixed	The data that should be formatted.
return	yii\web\Response	A response that is configured to send $data formatted as JSON.

asXml() public method (available since version 2.0.11)

Send data formatted as XML.

This method is a shortcut for sending data formatted as XML. It will return the response application component after configuring the format and setting the data that should be formatted. A common usage will be:

return $this->asXml($data);

See also:

• yii\web\Response::$format
• yii\web\Response::FORMAT_XML
• yii\web\XmlResponseFormatter

public yii\web\Response asXml ( $data )
$data	mixed	The data that should be formatted.
return	yii\web\Response	A response that is configured to send $data formatted as XML.

beforeAction() public method

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.

bindActionParams() public method

Binds the parameters to the action.

This method is invoked by yii\base\Action when it begins to run with the given parameters. This method will check the parameter names that the action requires and return the provided parameters according to the requirement. If there is any missing parameter, an exception will be thrown.

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.
throws	yii\web\BadRequestHttpException	if there are missing or invalid parameters.

goBack() public method

Redirects the browser to the last visited page.

You can use this method in an action by returning the yii\web\Response directly:

// stop executing this action and redirect to last visited page
return $this->goBack();

For this function to work you have to set the return URL in appropriate places before.

See also yii\web\User::getReturnUrl().

public yii\web\Response goBack ( $defaultUrl = null )
$defaultUrl	string|array	The default return URL in case it was not set previously. If this is null and the return URL was not set previously, yii\web\Application::$homeUrl will be redirected to. Please refer to yii\web\User::setReturnUrl() on accepted format of the URL.
return	yii\web\Response	The current response object

goHome() public method

Redirects the browser to the home page.

You can use this method in an action by returning the yii\web\Response directly:

// stop executing this action and redirect to home page
return $this->goHome();

public yii\web\Response goHome ( )
return	yii\web\Response	The current response object

redirect() public method

Redirects the browser to the specified URL.

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

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

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

public yii\web\Response redirect ( $url, $statusCode = 302 )
$url	string|array	The URL to be redirected to. This can be in one of the following formats: a string representing a URL (e.g. "http://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.
$statusCode	integer	The HTTP status code. Defaults to 302. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for details about HTTP status code
return	yii\web\Response	The current response object

refresh() public method

Refreshes the current page.

This method is a shortcut to yii\web\Response::refresh().

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

// stop executing this action and refresh the current page
return $this->refresh();

public yii\web\Response refresh ( $anchor = '' )
$anchor	string	The anchor that should be appended to the redirection URL. Defaults to empty. Make sure the anchor starts with '#' if you want to specify it.
return	yii\web\Response	The response object itself

renderAjax() public method

Renders a view in response to an AJAX request.

This method is similar to renderPartial() except that it will inject into the rendering result with JS/CSS scripts and files which are registered with the view. For this reason, you should use this method instead of renderPartial() to render a view to respond to an AJAX request.

public string renderAjax ( $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.