Class CFilterWidget

CFilterWidget is the base class for widgets that can also be used as filters.

Derived classes may need to override the following methods:

CWidget::init() : called when this is object is used as a widget and needs initialization.
CWidget::run() : called when this is object is used as a widget.
CFilterWidget::filter() : the filtering method called when this object is used as an action filter.

CFilterWidget provides all properties and methods of CWidget and CFilter.

CComponent

CBaseController

CWidget

CFilterWidget implements IFilter

Package: system\web\widgets
Copyright: 2008-2013 Yii Software LLC
License: http://www.yiiframework.com/license/
Author: Qiang Xue <qiang.xue@gmail.com>
Since: 1.0
Located at x2engine/framework/web/widgets/CFilterWidget.php

Methods summary
`public`	# `__construct( CBaseController $owner = null )` Constructor. Constructor. Parameters `$owner` `CBaseController` $owner owner/creator of this widget. It could be either a widget or a controller. Overrides `CWidget::__construct()`
`public boolean`	# `getIsFilter( )` Returns `boolean` whether this widget is used as a filter.
`public`	# `filter( CFilterChain $filterChain )` Performs the filtering. The default implementation simply calls `CWidget::init()`, `CFilterChain::run()` and `CWidget::run()` in order Derived classes may want to override this method to change this behavior. Performs the filtering. The default implementation simply calls `CWidget::init()`, `CFilterChain::run()` and `CWidget::run()` in order Derived classes may want to override this method to change this behavior. Parameters `$filterChain` `CFilterChain` $filterChain the filter chain that the filter is on. Implementation of `IFilter::filter()`

Methods inherited from CWidget
`actions(), getController(), getId(), getOwner(), getViewFile(), getViewPath(), init(), render(), run(), setId()`

Methods inherited from CBaseController
`beginCache(), beginClip(), beginContent(), beginWidget(), createWidget(), endCache(), endClip(), endContent(), endWidget(), renderFile(), renderInternal(), widget()`

Methods inherited from CComponent
`__call(), __get(), __isset(), __set(), __unset(), asa(), attachBehavior(), attachBehaviors(), attachEventHandler(), canGetProperty(), canSetProperty(), detachBehavior(), detachBehaviors(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), getEventHandlers(), hasEvent(), hasEventHandler(), hasProperty(), raiseEvent()`

Properties summary
`public boolean`	`$stopAction`	`false`	# whether to stop the action execution when this widget is used as a filter. This property should be changed only in `CWidget::init()` method. Defaults to false, meaning the action should be executed. whether to stop the action execution when this widget is used as a filter. This property should be changed only in `CWidget::init()` method. Defaults to false, meaning the action should be executed.

Properties inherited from CWidget
`$actionPrefix, $skin`

Magic properties summary
`public boolean`	`$isFilter`	# Whether this widget is used as a filter. Whether this widget is used as a filter.

Magic properties inherited from CWidget
`$controller, $id, $owner, $viewPath`