包 | system.web.filters |
---|---|
继承 | class CFilterChain » CList » CComponent |
实现 | Countable, ArrayAccess, Traversable, IteratorAggregate |
源自 | 1.0 |
版本 | $Id: CFilterChain.php 3204 2011-05-05 21:36:32Z alexander.makarow $ |
源码 |
公共属性
属性 | 类型 | 描述 | 定义在 |
---|---|---|---|
action | CAction | 通过这个流程过滤的动作。 | CFilterChain |
controller | CController | 运行这个动作的控制器。 | CFilterChain |
count | integer | 返回列表的项目数。 | CList |
filterIndex | integer | 当调用run()时要运行的过滤器索引。 | CFilterChain |
iterator | Iterator | 返回遍历这个项目列表的迭代器。 | CList |
readOnly | boolean | 返回值说明这个列表是否为只读。默认为false。 | CList |
公共方法
受保护方法
方法 | 描述 | 定义在 |
---|---|---|
setReadOnly() | 设置设置这个列表是否为只读 | CList |
属性详细
action
属性
public CAction $action;
通过这个流程过滤的动作。
controller
属性
public CController $controller;
运行这个动作的控制器。
filterIndex
属性
public integer $filterIndex;
当调用run()时要运行的过滤器索引。
方法详细
__construct()
方法
public void __construct(CController $controller, CAction $action)
| ||
$controller | CController | 运行这个动作的控制器。 |
$action | CAction | 在流程中被过滤的动作。 |
public function __construct($controller,$action)
{
$this->controller=$controller;
$this->action=$action;
}
构造方法。
create()
方法
public static CFilterChain create(CController $controller, CAction $action, array $filters)
| ||
$controller | CController | 运行这个动作的控制器。 |
$action | CAction | 在流程中被过滤的动作。 |
$filters | array | 应用到这个动作的过滤器列表。 |
{return} | CFilterChain |
public static function create($controller,$action,$filters)
{
$chain=new CFilterChain($controller,$action);
$actionID=$action->getId();
foreach($filters as $filter)
{
if(is_string($filter)) // filterName [+|- action1 action2]
{
if(($pos=strpos($filter,'+'))!==false || ($pos=strpos($filter,'-'))!==false)
{
$matched=preg_match("/\b{$actionID}\b/i",substr($filter,$pos+1))>0;
if(($filter[$pos]==='+')===$matched)
$filter=CInlineFilter::create($controller,trim(substr($filter,0,$pos)));
}
else
$filter=CInlineFilter::create($controller,$filter);
}
else if(is_array($filter)) // array('path.to.class [+|- action1, action2]','param1'=>'value1',...)
{
if(!isset($filter[0]))
throw new CException(Yii::t('yii','The first element in a filter configuration must be the filter class.'));
$filterClass=$filter[0];
unset($filter[0]);
if(($pos=strpos($filterClass,'+'))!==false || ($pos=strpos($filterClass,'-'))!==false)
{
$matched=preg_match("/\b{$actionID}\b/i",substr($filterClass,$pos+1))>0;
if(($filterClass[$pos]==='+')===$matched)
$filterClass=trim(substr($filterClass,0,$pos));
else
continue;
}
$filter['class']=$filterClass;
$filter=Yii::createComponent($filter);
}
if(is_object($filter))
{
$filter->init();
$chain->add($filter);
}
}
return $chain;
}
CFilterChain工厂方法。 这个方法创建一个CFilterChain实例。
insertAt()
方法
public void insertAt(integer $index, mixed $item)
| ||
$index | integer | 指定的位置。 |
$item | mixed | 新的项目。 |
public function insertAt($index,$item)
{
if($item instanceof IFilter)
parent::insertAt($index,$item);
else
throw new CException(Yii::t('yii','CFilterChain can only take objects implementing the IFilter interface.'));
}
将项目插入到指定的位置。 这个方法重写父类方法, 实现了在添加过程中作 一些额外的检查。特别是, 只有实现IFilter才会被添加到这个列表。
run()
方法
public void run()
|
public function run()
{
if($this->offsetExists($this->filterIndex))
{
$filter=$this->itemAt($this->filterIndex++);
Yii::trace('Running filter '.($filter instanceof CInlineFilter ? get_class($this->controller).'.filter'.$filter->name.'()':get_class($filter).'.filter()'),'system.web.filters.CFilterChain');
$filter->filter($this);
}
else
$this->controller->runAction($this->action);
}
运行在filterIndex索引的过滤器。 当调用这个方法之后,filterIndex会自动加1。 这个方法通常在过滤器里面调用, 所以过滤的过程能够继续进行,动作也可以执行下去。