/demo/yii/web/filters/CInlineFilter.php
PHP | 61 lines | 22 code | 3 blank | 36 comment | 1 complexity | 968a15a30d85cbc3950302a81b31553b MD5 | raw file
Possible License(s): Apache-2.0, BSD-3-Clause, GPL-3.0, LGPL-2.1, BSD-2-Clause
- <?php
- /**
- * CInlineFilter class file.
- *
- * @author Qiang Xue <qiang.xue@gmail.com>
- * @link http://www.yiiframework.com/
- * @copyright Copyright © 2008-2011 Yii Software LLC
- * @license http://www.yiiframework.com/license/
- */
- /**
- * CInlineFilter represents a filter defined as a controller method.
- *
- * CInlineFilter executes the 'filterXYZ($action)' method defined
- * in the controller, where the name 'XYZ' can be retrieved from the {@link name} property.
- *
- * @author Qiang Xue <qiang.xue@gmail.com>
- * @version $Id$
- * @package system.web.filters
- * @since 1.0
- */
- class CInlineFilter extends CFilter
- {
- /**
- * @var string name of the filter. It stands for 'XYZ' in the filter method name 'filterXYZ'.
- */
- public $name;
- /**
- * Creates an inline filter instance.
- * The creation is based on a string describing the inline method name
- * and action names that the filter shall or shall not apply to.
- * @param CController $controller the controller who hosts the filter methods
- * @param string $filterName the filter name
- * @return CInlineFilter the created instance
- * @throws CException if the filter method does not exist
- */
- public static function create($controller,$filterName)
- {
- if(method_exists($controller,'filter'.$filterName))
- {
- $filter=new CInlineFilter;
- $filter->name=$filterName;
- return $filter;
- }
- else
- throw new CException(Yii::t('yii','Filter "{filter}" is invalid. Controller "{class}" does not have the filter method "filter{filter}".',
- array('{filter}'=>$filterName, '{class}'=>get_class($controller))));
- }
- /**
- * Performs the filtering.
- * This method calls the filter method defined in the controller class.
- * @param CFilterChain $filterChain the filter chain that the filter is on.
- */
- public function filter($filterChain)
- {
- $method='filter'.$this->name;
- $filterChain->controller->$method($filterChain);
- }
- }