Commit 8c4b5874 by Qiang Xue

Merge pull request #1690 from Ragazzo/controller_docs_response

docs about response
parents 757115bc cf917bee
...@@ -35,7 +35,8 @@ class SiteController extends Controller ...@@ -35,7 +35,8 @@ class SiteController extends Controller
``` ```
As you can see, typical controller contains actions that are public class methods named as `actionSomething`. As you can see, typical controller contains actions that are public class methods named as `actionSomething`.
The output of an action is what the method returns. The return value will be handled by the `response` application The output of an action is what the method returns, it could be rendered result or it can be instance of ```yii\web\Response```, for [example](#custom-response-class).
The return value will be handled by the `response` application
component which can convert the output to differnet formats such as JSON for example. The default behavior component which can convert the output to differnet formats such as JSON for example. The default behavior
is to output the value unchanged though. is to output the value unchanged though.
...@@ -246,6 +247,29 @@ Catching all incoming requests ...@@ -246,6 +247,29 @@ Catching all incoming requests
TBD TBD
Custom response class
---------------------
```php
namespace app\controllers;
use yii\web\Controller;
use app\components\web\MyCustomResponse; #extended from yii\web\Response
class SiteController extends Controller
{
public function actionCustom()
{
/*
* do your things here
* since Response in extended from yii\base\Object, you can initialize its values by passing in
* __constructor() simple array.
*/
return new MyCustomResponse(['data' => $myCustomData]);
}
}
```
See also See also
-------- --------
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment