Class CFilterChain

CFilterChain represents a list of filters being applied to an action.

CFilterChain executes the filter list by CFilterChain::run().

CComponent

CList implements IteratorAggregate, ArrayAccess, Countable

CFilterChain

Package: system\web\filters
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/filters/CFilterChain.php

Methods summary
`public`	# `__construct( CController $controller, CAction $action )` Constructor. Constructor. Parameters `$controller` `CController` $controller the controller who executes the action. `$action` `CAction` $action the action being filtered by this chain. Throws `CException` If data is not null and neither an array nor an iterator. Overrides `CList::__construct()`
`public static CFilterChain`	# `create( CController $controller, CAction $action, array $filters )` CFilterChain factory method. This method creates a CFilterChain instance. CFilterChain factory method. This method creates a CFilterChain instance. Parameters `$controller` `CController` $controller the controller who executes the action. `$action` `CAction` $action the action being filtered by this chain. `$filters` `array` $filters list of filters to be applied to the action. Returns `CFilterChain`
`public`	# `insertAt( integer $index, mixed $item )` Inserts an item at the specified position. This method overrides the parent implementation by adding additional check for the item to be added. In particular, only objects implementing `IFilter` can be added to the list. Inserts an item at the specified position. This method overrides the parent implementation by adding additional check for the item to be added. In particular, only objects implementing `IFilter` can be added to the list. Parameters `$index` `integer` $index the specified position. `$item` `mixed` $item new item Throws `CException` If the index specified exceeds the bound or the list is read-only, or the item is not an `IFilter` instance. Overrides `CList::insertAt()`
`public`	# `run( )` Executes the filter indexed at `CFilterChain::$filterIndex`. After this method is called, `CFilterChain::$filterIndex` will be automatically incremented by one. This method is usually invoked in filters so that the filtering process can continue and the action can be executed. Executes the filter indexed at `CFilterChain::$filterIndex`. After this method is called, `CFilterChain::$filterIndex` will be automatically incremented by one. This method is usually invoked in filters so that the filtering process can continue and the action can be executed.

Methods inherited from CList
`add(), clear(), contains(), copyFrom(), count(), getCount(), getIterator(), getReadOnly(), indexOf(), itemAt(), mergeWith(), offsetExists(), offsetGet(), offsetSet(), offsetUnset(), remove(), removeAt(), setReadOnly(), toArray()`

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 CController`	`$controller`		# the controller who executes the action. the controller who executes the action.
`public CAction`	`$action`		# the action being filtered by this chain. the action being filtered by this chain.
`public integer`	`$filterIndex`	`0`	# the index of the filter that is to be executed when calling `CFilterChain::run()`. the index of the filter that is to be executed when calling `CFilterChain::run()`.

Magic properties inherited from CList
`$count, $iterator, $readOnly`

Packages

Classes

Class CFilterChain

Parameters

Throws

Overrides

Parameters

Returns

Parameters

Throws

Overrides