Yii Framework v1.1.10 类参考
CFilterWidget
| 包 | system.web.widgets |
|---|---|
| 继承 | class CFilterWidget » CWidget » CBaseController » CComponent |
| 实现 | IFilter |
| 子类 | COutputCache, COutputProcessor |
| 源自 | 1.0 |
| 版本 | $Id: CFilterWidget.php 3515 2011-12-28 12:29:24Z mdomba $ |
| 源码 | framework/web/widgets/CFilterWidget.php |
CFilterWidget 是各种可以用作过滤器的小物件的基类。
派生类可能需要覆盖下列方法：
CFilterWidget 提供了CWidget 和 CFilter的所有属性和方法。
派生类可能需要覆盖下列方法：
- CWidget::init() : 当此对象被作为一个小物件使用，并且需要进行初始化时调用此方法。
- CWidget::run() : 当此对象被作为一个小物件使用时调用此方法。
- filter() : 当此对象作为一个动作过滤器蝗调用的过滤方法。
CFilterWidget 提供了CWidget 和 CFilter的所有属性和方法。
公共属性
| 属性 | 类型 | 描述 | 定义在 |
|---|---|---|---|
| actionPrefix | string | actions的ID的前缀。 当微件在CController::actions中声明了 动作提供者，可以为其动作的ID指定前缀以区别 于别的微件或控制器。当微件用于控制器 的视图中时，必须配置同样的前缀。 | CWidget |
| controller | CController | 返回此微件所属的控制器。 | CWidget |
| id | string | 返回此微件的ID。如果需要的话，将生产一个新的ID并将其返回。 | CWidget |
| isFilter | boolean | 这个widget是否作为一个过滤器使用。 | CFilterWidget |
| owner | CBaseController | 返回此微件的所有者或创建者。 | CWidget |
| skin | mixed | 微件使用的皮肤的名称。默认为“default”。 如果此属性设置为false，微件将不会有皮肤被使用。 | CWidget |
| stopAction | boolean | 当这个widget用作一个过滤器时是否停止动作的执行。 此属性应当仅在CWidget::init方法中进行改变。 默认值是false，表示动作将会被执行。 | CFilterWidget |
| viewPath | string | 返回包含此微件所需的视图文件的路径。 | CWidget |
公共方法
属性详细
isFilter
属性
只读
public boolean getIsFilter()
这个widget是否作为一个过滤器使用。
stopAction
属性
public boolean $stopAction;
当这个widget用作一个过滤器时是否停止动作的执行。 此属性应当仅在CWidget::init方法中进行改变。 默认值是false，表示动作将会被执行。
方法详细
__construct()
方法
|
public void __construct(CBaseController $owner=NULL)
| ||
| $owner | CBaseController | 这个widget的拥有者或创建者。可以是widget或controller。 |
源码： framework/web/widgets/CFilterWidget.php#45 (显示)
public function __construct($owner=null)
{
parent::__construct($owner);
$this->_isFilter=($owner===null);
}
构造器。
filter()
方法
|
public void filter(CFilterChain $filterChain)
| ||
| $filterChain | CFilterChain | 过滤器所在的链。 |
源码： framework/web/widgets/CFilterWidget.php#66 (显示)
public function filter($filterChain)
{
$this->init();
if(!$this->stopAction)
{
$filterChain->run();
$this->run();
}
}
执行过滤。 默认的实现方式是简单地按顺序执行init()， CFilterChain::run() 和 run() 派生类可以覆盖此方法以改变它的行为。
getIsFilter()
方法
|
public boolean getIsFilter()
| ||
| {return} | boolean | 这个widget是否作为一个过滤器使用。 |
源码： framework/web/widgets/CFilterWidget.php#54 (显示)
public function getIsFilter()
{
return $this->_isFilter;
}