IFilter
Package | system.base |
---|---|
Inheritance | interface IFilter |
Subclasses | CAccessControlFilter, CContentDecorator, CFilter, CFilterWidget, CHtmlPurifier, CInlineFilter, CMarkdown, COutputCache, COutputProcessor, CTextHighlighter |
Since | 1.0 |
Version | $Id: interfaces.php 3515 2011-12-28 12:29:24Z mdomba $ |
Source Code | framework/base/interfaces.php |
IFilter is the interface that must be implemented by action filters.
Public Methods
Method | Description | Defined By |
---|---|---|
filter() | Performs the filtering. | IFilter |
Method Details
filter()
method
abstract public void filter(CFilterChain $filterChain)
| ||
$filterChain | CFilterChain | the filter chain that the filter is on. |
Performs the filtering.
This method should be implemented to perform actual filtering.
If the filter wants to continue the action execution, it should call
$filterChain->run()
.