0 follower

CFilterWidget

Package system.web.widgets
Inheritance class CFilterWidget » CWidget » CBaseController » CComponent
Implements IFilter
Subclasses COutputCache, COutputProcessor
Since 1.0
Version $Id$
Source Code framework/web/widgets/CFilterWidget.php
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.
  • filter() : the filtering method called when this object is used as an action filter.


CFilterWidget provides all properties and methods of CWidget and CFilter.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
actionPrefix string the prefix to the IDs of the actions. CWidget
controller CController the controller that this widget belongs to. CWidget
id string id of the widget. CWidget
isFilter boolean whether this widget is used as a filter. CFilterWidget
owner CBaseController owner/creator of this widget. CWidget
stopAction boolean whether to stop the action execution when this widget is used as a filter. CFilterWidget
viewPath string Returns the directory containing the view files for this widget. CWidget

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. CComponent
__construct() Constructor. CFilterWidget
__get() Returns a property value, an event handler list or a behavior based on its name. CComponent
__isset() Checks if a property value is null. CComponent
__set() Sets value of a component property. CComponent
__unset() Sets a component property to be null. CComponent
actions() Returns a list of actions that are used by this widget. CWidget
asa() Returns the named behavior object. CComponent
attachBehavior() Attaches a behavior to this component. CComponent
attachBehaviors() Attaches a list of behaviors to the component. CComponent
attachEventHandler() Attaches an event handler to an event. CComponent
beginCache() Begins fragment caching. CBaseController
beginClip() Begins recording a clip. CBaseController
beginContent() Begins the rendering of content that is to be decorated by the specified view. CBaseController
beginWidget() Creates a widget and executes it. CBaseController
canGetProperty() Determines whether a property can be read. CComponent
canSetProperty() Determines whether a property can be set. CComponent
createWidget() Creates a widget and initializes it. CBaseController
detachBehavior() Detaches a behavior from the component. CComponent
detachBehaviors() Detaches all behaviors from the component. CComponent
detachEventHandler() Detaches an existing event handler. CComponent
disableBehavior() Disables an attached behavior. CComponent
disableBehaviors() Disables all behaviors attached to this component. CComponent
enableBehavior() Enables an attached behavior. CComponent
enableBehaviors() Enables all behaviors attached to this component. CComponent
endCache() Ends fragment caching. CBaseController
endClip() Ends recording a clip. CBaseController
endContent() Ends the rendering of content. CBaseController
endWidget() Ends the execution of the named widget. CBaseController
filter() Performs the filtering. CFilterWidget
getController() Returns the controller that this widget belongs to. CWidget
getEventHandlers() Returns the list of attached event handlers for an event. CComponent
getId() Returns id of the widget. CWidget
getIsFilter() Checks whether this widget is used as a filter. CFilterWidget
getOwner() Returns owner/creator of this widget. It could be either a widget or a controller. CWidget
getViewFile() Looks for the view script file according to the view name. CWidget
getViewPath() Returns the directory containing the view files for this widget. CWidget
hasEvent() Determines whether an event is defined. CComponent
hasEventHandler() Checks whether the named event has attached handlers. CComponent
hasProperty() Determines whether a property is defined. CComponent
init() Initializes the widget. CWidget
raiseEvent() Raises an event. CComponent
render() Renders a view. CWidget
renderFile() Renders a view file. CBaseController
renderInternal() Renders a view file. CBaseController
run() Executes the widget. CWidget
setId() Sets id of the widget. CWidget
widget() Creates a widget and executes it. CBaseController

Property Details

isFilter property read-only (available since v1.0.4)
public boolean getIsFilter()

whether this widget is used as a filter.

stopAction property
public boolean $stopAction;

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.

Method Details

__construct() method
public void __construct(CBaseController $owner=NULL)
$owner CBaseController owner/creator of this widget. It could be either a widget or a controller.
Source Code: framework/web/widgets/CFilterWidget.php#43 (show)
public function __construct($owner=null)
{
    parent::__construct($owner);
    $this->_isFilter=($owner===null);
}

Constructor.

filter() method
public void filter(CFilterChain $filterChain)
$filterChain CFilterChain the filter chain that the filter is on.
Source Code: framework/web/widgets/CFilterWidget.php#65 (show)
public function filter($filterChain)
{
    $this->init();
    if(!$this->stopAction)
    {
        $filterChain->run();
        $this->run();
    }
}

Performs the filtering. The default implementation simply calls init(), CFilterChain::run() and run() in order Derived classes may want to override this method to change this behavior.

getIsFilter() method (available since v1.0.4)
public boolean getIsFilter()
{return} boolean whether this widget is used as a filter.
Source Code: framework/web/widgets/CFilterWidget.php#53 (show)
public function getIsFilter()
{
    return $this->_isFilter;
}