Class yii\base\ActionFilter

所有类 | 属性 | 方法

继承	yii\base\ActionFilter » yii\base\Behavior » yii\base\Object
可用自版本	2.0

ActionFilter是行动的基类过滤器。

一个行动过滤器将参与行动执行工作流通过应对beforeAction和afterAction事件触发模块和控制器。

Check

yii\filters\AccessControl,过滤器的实现,yii\filters\PageCache 和yii\filters\HttpCache为例对如何使用它。

在ActionFilter更多细节和使用信息,请参阅指南文

公共属性

隐藏继承属性

属性	类型	描述	定义在
$except	array	行动id列表,这个过滤器应该不适用	yii\base\ActionFilter
$only	array	行动id列表,这个过滤器应该适用。	yii\base\ActionFilter

公共方法

隐藏继承方法

方法	描述	定义在
afterAction()	调用该方法之后执行一个动作。	yii\base\ActionFilter
afterFilter()		yii\base\ActionFilter
attach()		yii\base\ActionFilter
beforeAction()	调用这个方法之前执行一个动作(在所有可能的过滤器)。你可以重写这个方法做最后的准备。	yii\base\ActionFilter
beforeFilter()		yii\base\ActionFilter
detach()		yii\base\ActionFilter

受保护的方法

隐藏继承方法

方法	描述	定义在
getActionId()	返回一个动作ID将yii \基地\行动::$ uniqueId相对于模块ID	yii\base\ActionFilter
isActive()	返回一个值指示是否过滤器是积极为给定的行动。	yii\base\ActionFilter

属性详情

$except public property

行动id列表,这个过滤器应该不适用。

参见 $only.

public array $except = []

$only public property

行动id列表,这个过滤器应该适用。如果不设置这个属性,那么过滤器适用于所有行动,除非他们在除了美元上市。如果一个操作ID出现在两种,除了美元,这个过滤器将不适用。

注意,如果过滤器是附加到模块,操作id还应该包括子模块id(如果有的话)和控制器id。

从版本2.0.9行动IDs可以指定为通配符,如网站site/ *。

参见 $except.

public array $only = null

方法详情

afterAction() public 方法

调用该方法之后执行一个动作。

你可以重写这个方法做一些后处理的行动。

public mixed afterAction ( $action, $result )
$action	yii\base\Action	执行的行动。
$result	mixed	动作执行结果
return	mixed	处理行动的结果。

afterFilter() public 方法

public void afterFilter ( $event )
$event	yii\base\ActionEvent

attach() public 方法

public void attach ( $owner )
$owner

beforeAction() public 方法

调用这个方法之前执行一个动作(在所有可能的过滤器)。你可以重写这个方法做最后的准备。

public boolean beforeAction ( $action )
$action	yii\base\Action	要执行的动作。
return	boolean	行动是否应该继续执行。

beforeFilter() public 方法

public void beforeFilter ( $event )
$event	yii\base\ActionEvent

detach() public 方法

public void detach ( )

getActionId() protected 方法 （可用自版本 2.0.7）

返回一个动作ID将yii\base\Action::$uniqueId相对于模块ID

protected string getActionId ( $action )
$action	yii\base\Action

isActive() protected 方法

返回一个值指示是否过滤器是积极为给定的行动。

protected boolean isActive ( $action )
$action	yii\base\Action	行动被过滤
return	boolean	过滤器是否积极的行动。