IFilter

Package	system.base
Inheritance	interface IFilter
Subclasses	CAccessControlFilter, CContentDecorator, CFilter, CFilterWidget, CHtmlPurifier, CHttpCacheFilter, CInlineFilter, CMarkdown, COutputCache, COutputProcessor, CTextHighlighter
Since	1.0
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.

Source Code: framework/base/interfaces.php#163 (show)

public function filter($filterChain);

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().

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/IFilter