Yii2.0源码分析之——Web控制器文件分析(yii\web\Controller.php)

十度 Yii2 2015年11月30日 收藏

这个控制器大体也分三部分

  • action相关功能
  • render相关功能
  • 常用response简写


1、action相关功能

action中绑定参数功能:public function bindActionParams($action, $params)

  1. /*
  2. * 这个是基类的 action中绑定参数功能的实现
  3. * 根据action中定义的参数,从$_GET中取对应的值,
  4. * 如果没有,则报错
  5. */
  6. public function bindActionParams($action, $params)
  7. {
  8.         /*
  9.          * 先通过反射得到动作action的方法信息
  10.          * 
  11.          * 有两种action,
  12.          * 一种是Yii提供的InlineAction,我们在控制器里面定义的actionXXX都是这种类型
  13.          * 另外一个就是独立action,直接继承自Action类,并实现里面的run方法。
  14.          */
  15.         if ($action instanceof InlineAction) {
  16.             $method = new \ReflectionMethod($this, $action->actionMethod);
  17.         } else {
  18.             $method = new \ReflectionMethod($action, 'run');
  19.         }
  20.         $args = [];
  21.         $missing = [];
  22.         $actionParams = [];
  23.         foreach ($method->getParameters() as $param) {
  24.             //获取在action中定义的参数的名称。
  25.             //如action定义为:actionIndex($x,$y=5)
  26.             $name = $param->getName();
  27.             //如果action中定义 的参数存在于$_GET中
  28.             if (array_key_exists($name, $params)) {
  29.                 if ($param->isArray()) {
  30.                     /*
  31.                      * 如果参数是数组类型的,
  32.                      * 如果从$_GET中取得的数据是数组,返回
  33.                      * 否则包装到数组
  34.                      */
  35.                     $args[] = $actionParams[$name] = is_array($params[$name]) ? $params[$name] : [$params[$name]];
  36.                 } elseif (!is_array($params[$name])) {
  37.                     /*
  38.                      * 如果不是数组,直接返回$_GET中对应的结果
  39.                      */
  40.                     $args[] = $actionParams[$name] = $params[$name];
  41.                 } else {
  42.                     throw new BadRequestHttpException(Yii::t('yii', 'Invalid data received for parameter "{param}".', [
  43.                         'param' => $name,
  44.                     ]));
  45.                 }
  46.                 unset($params[$name]);            
  47.             } elseif ($param->isDefaultValueAvailable()) {
  48.                 //如果默认有默认值。
  49.                 $args[] = $actionParams[$name] = $param->getDefaultValue();
  50.             } else {
  51.                 //action中定义的参数没有在$_GET中找到。
  52.                 $missing[] = $name;
  53.             }
  54.         }
  55.         //action中的参数有缺少,报异常
  56.         if (!empty($missing)) {
  57.             throw new BadRequestHttpException(Yii::t('yii', 'Missing required parameters: {params}', [
  58.                 'params' => implode(', ', $missing),
  59.             ]));
  60.         }
  61.         $this->actionParams = $actionParams;
  62.         return $args;
  63. }

启动csrf验证功能

  1. //这个重写基类的beforeAction
  2. public function beforeAction($action)
  3. {
  4.         if (parent::beforeAction($action)) {
  5.                 //启动csrf验证功能
  6.             if ($this->enableCsrfValidation && Yii::$app->errorHandler->exception === null && !Yii::$app->getRequest()->validateCsrfToken()) {
  7.                 throw new BadRequestHttpException(Yii::t('yii', 'Unable to verify your data submission.'));
  8.             }
  9.             return true;
  10.         } else {
  11.             return false;
  12.         }
  13. }

2、render相关功能

除了基类的几个render外,在这个里面还增加了一种对ajax请求的响应

  1. /*
  2. * 这个渲染的结棍用来作为ajax请求的的响应
  3. * 这个方法和renderPartial类似,但这个返回的结果中会包含css/js以及其它在view中注册的文件。
  4. */
  5. public function renderAjax($view, $params = [])
  6. {
  7.         return $this->getView()->renderAjax($view, $params, $this);
  8. }

3、常用response简写

重定向
public function redirect($url, $statusCode = 302)
其中$url参数为

  • 别名url,如:"@yiifans.com"
  • 数组,如果为数组的话格式为[$route,.....name-value...],如:['site/index','id'=>5,'keyword'=>'test'],


不管哪种参数,都会在redirect内部用 Url::to() 来处理。

另外,如果传入的是相对的url,都会根据当前请求的host info 转换为绝对url,

返回首页

  1. public function goHome()

后退

  1. public function goBack($defaultUrl = null)

其中$defaultUrl为字符串或数组

刷新

  1. public function refresh($anchor = '')