Yii filter 详解

filters()方法定义在CController里,用Gii生成Controller时里面就有filters方法,代码如下:

代码 收藏代码
  1. publicfunctionfilters()
  2. {
  3. //returnthefilterconfigurationforthiscontroller,e.g.:
  4. returnarray(
  5. 'inlineFilterName',
  6. array(
  7. 'class'=>'path.to.FilterClass',
  8. 'propertyName'=>'propertyValue',
  9. ),
  10. );
  11. }

这个方法没有做什么实质性的动作,它只是把你将要执行的过滤方法方法名或者过滤类的类名返回给CController。 我们先看使用方法的方式,也即上面代码里的’inlineFilterName’含义,这个inlineFilterName意思是在当前控制器的类中有 一个inlineFilterName()方法,该方法里就是你要执行的过滤规则,比如:当前在TestController里:

代码 收藏代码
  1. <?php
  2. classTestControllerextendsCController{
  3. //该方法判断用户是否登录
  4. publicfunctionfilterInlineFilterName($filterChain){
  5. if(Yii::app()->user->isGuest)
  6. Yii::app()->user->loginRequired();//封装了登录的url
  7. $filterChain->run();//参数$filterChain就是执行该filter的action实例,调用$filterChain->run()其实就是执行该action了。
  8. }
  9. publicfunctionfilters(){
  10. returnarray('inlineFilterName');
  11. }
  12. }
  13. ?>

Ok,上面的代码就是对当前控制器的所有action都执行了检查用户是否登录了操作,如果用户未登录则跳转到登录页,如果登录则继续执行action里的内容。这是利用在当前控制器下写方法的方式执行过滤,同样,写成类也是可以的,引入方式

代码 收藏代码
  1. publicfunctionfilters()
  2. {
  3. //returnthefilterconfigurationforthiscontroller,e.g.:
  4. returnarray(
  5. array(
  6. 'class'=>'path.to.FilterClass',//类名
  7. 'propertyName'=>'propertyValue',//属性名,属性值
  8. ),
  9. );
  10. }

那可能有的哥们要问了,那要是我想让特定的方法检查是否登录了怎么做呢?下面就是我要说的了,同样,还是在TestController里:

代码 收藏代码
  1. <?php
  2. classTestControllerextendsCController{
  3. //该方法判断用户是否登录
  4. publicfunctionfilterInlineFilterName($filterChain){//必须以filter开头,后跟名字
  5. if(Yii::app()->user->isGuest&&!in_array($filterChain->action->id,$this->inlineFilterNameAction()))
  6. Yii::app()->user->loginRequired();//封装了登录的url
  7. $filterChain->run();//参数$filterChain就是执行该filter的action实例,调用$filterChain->run()其实就是执行该action了。
  8. }
  9. publicfunctionfilters(){
  10. returnarray('inlineFilterName'),
  11. }
  12. publicfunctioninlineFilterNameAction(){//返回要执行过滤的action
  13. returnarray('action1','action2','action3');
  14. }
  15. }
  16. ?>

这样就可以做到对指定的action添加自定义的过滤规则了。

其实,Yii里已经封装好了一个过滤类,这里带大家看看它是怎样实现的,其实原理和上面一模一样。我们先来看看CController里的public void filterAccessControl(CFilterChain $filterChain) 方法:

代码 收藏代码
  1. publicfunctionfilterAccessControl($filterChain)
  2. {
  3. $filter=newCAccessControlFilter;
  4. $filter->setRules($this->accessRules());
  5. $filter->filter($filterChain);
  6. }

可以看到,它是以filter开头的函数,大家知道它是干嘛的了吧?该方法实例化了一个CAccessControlFilter类,该类就是处理过滤规则的,然后把$this->accessRules()作为一个参数付给 $filter->setRules()方法。 下面来看看accessRules()方法的写法:

代码 收藏代码
  1. publicfunctionaccessRules()
  2. {
  3. returnarray(
  4. 'allow',//or'deny'
  5. //可选规则,本规则适用于列出的所有动作ID(不区分大小写)
  6. //如果未指定此项,则规则适用于所有动作。
  7. 'actions'=>array('edit','delete'),
  8. //可选规则,本规则适用于列出的所有控制器ID(不区分大小写)
  9. 'controllers'=>array('post','admin/user'),
  10. //可选规则,本规则适用于列出的所有用户ID(不区分大小写)
  11. //使用*号表示所有用户,?号表示来宾用户,@表示通过身份验证的用户。
  12. 'users'=>array('thomas','kevin'),
  13. //可选规则,本规则适用于列出的所有角色(区分大小写)。
  14. 'roles'=>array('admin','editor'),
  15. //可选规则,本规则适用于列出的所有IP地址。
  16. //如127.0.0.1,127.0.0.*
  17. 'ips'=>array('127.0.0.1'),
  18. //可选规则,本规则适用于列出的所有请求类型(区分大小写)。
  19. 'verbs'=>array('GET','POST'),
  20. //可选规则,一个PHP表达式,其值表示此规则是否适用
  21. 'expression'=>'!$user->isGuest&&$user->level==2',
  22. //可选规则,显示自定义的错误消息
  23. //自1.1.1版后,此选项开始使用。
  24. 'message'=>'AccessDenied.',
  25. );
  26. }

你可能感兴趣的:(filter)