| 包 | system.web.filters |
|---|---|
| 继承 | class CFilter » CComponent |
| 实现 | IFilter |
| 子类 | CAccessControlFilter, CInlineFilter |
| 源自 | 1.0 |
| 版本 | $Id: CFilter.php 2799 2011-01-01 19:31:13Z qiang.xue $ |
| 源码 |
CFilter是所有过滤器的基类。
过滤器可用于动作执行之前和之后。 它可以修改动作的上下文执行， 或者修改动作所产生的结果。
重写preFilter()指定在动作之前执行 的过滤逻辑，重写postFilter()在动作之后的执行过滤逻辑。
过滤器可用于动作执行之前和之后。 它可以修改动作的上下文执行， 或者修改动作所产生的结果。
重写preFilter()指定在动作之前执行 的过滤逻辑，重写postFilter()在动作之后的执行过滤逻辑。
公共方法
受保护方法
| 方法 | 描述 | 定义在 |
|---|---|---|
| postFilter() | 执行post操作过滤器。 | CFilter |
| preFilter() | 执行预操作过滤器。 | CFilter |
方法详细
filter()
方法
|
public void filter(CFilterChain $filterChain)
| ||
| $filterChain | CFilterChain | 设置好的过滤器链。 |
public function filter($filterChain)
{
if($this->preFilter($filterChain))
{
$filterChain->run();
$this->postFilter($filterChain);
}
}
执行过滤。
默认实现的是调用preFilter
和postFilter，子类
应该覆盖这个方法。如果子类需要覆盖这个方法，
要确定动作执行时调用
$filterChain->run()。
init()
方法
（可用自 v1.1.4）
|
public void init()
|
public function init()
{
}
初始化过滤器。 这个方法会在过滤器属性已经初始化， preFilter调用之前调用。 你可以覆盖这个方法以包含一些初始化的逻辑。
postFilter()
方法
|
protected void postFilter(CFilterChain $filterChain)
| ||
| $filterChain | CFilterChain | 设置好的过滤器链。 |
protected function postFilter($filterChain)
{
}
执行post操作过滤器。
preFilter()
方法
|
protected boolean preFilter(CFilterChain $filterChain)
| ||
| $filterChain | CFilterChain | 设置好的过滤器链。 |
| {return} | boolean | 过滤过程是否要继承， 并且动作将要执行。 |
protected function preFilter($filterChain)
{
return true;
}
执行预操作过滤器。