Class yii\base\Action

所有类 | 属性 | 方法

继承	yii\base\Action » yii\base\Component » yii\base\Object
可用自版本	2.0

行动是所有控制器操作类的基类

行动提供了一种操作方法的代码重用。在action类中一个动作方法可用于多个控制器或在不同的项目。

派生类必须实现一个名为run()方法。这个方法将被调用控制器要求行动时。run()方法可以有参数将填满用户输入值自动根据他们的名字。例如,如果run()方法声明如下:

public function run($id, $type = 'book') { ... }

和参数提供的行动是:“id”= > 1。然后将调用run()方法自动运行(1)。

更多细节和使用信息行动,看到文章的行动指南。

公共属性

隐藏继承属性

属性	类型	描述	定义在
$controller	yii\base\Controller|yii\web\Controller	控制器拥有这个动作	yii\base\Action
$id	string	ID的行动	yii\base\Action

公共方法

隐藏继承方法

方法	描述	定义在
__construct()	Constructor.	yii\base\Action
getUniqueId()	返回这一行动的惟一的ID在整个应用程序中。	yii\base\Action
runWithParams()	这个动作用指定的参数运行。	yii\base\Action

受保护的方法

隐藏继承方法

方法	描述	定义在
afterRun()	调用此方法后运行()执行。	yii\base\Action
beforeRun()	这个方法被调用之前运行()执行	yii\base\Action

属性详情

$controller public property

控制器拥有这个动作

public yii\base\Controller|yii\web\Controller $controller = null

$id public property

ID的行动

public string $id = null

方法详情

__construct() public 方法

Constructor.

public void __construct ( $id, $controller, $config = [] )
$id	string	这一行动的ID
$controller	yii\base\Controller	控制器拥有这个动作
$config	array	名称-值对将用于初始化对象的属性

afterRun() protected 方法

调用此方法后run()执行。

你可以重写这个方法做后处理工作的操作运行。

protected void afterRun ( )

beforeRun() protected 方法

这个方法被调用之前run()执行。

你可以重写此方法为行动做准备工作。如果方法返回false,它将取消行动。

protected boolean beforeRun ( )
return	boolean	是否运行操作。

getUniqueId() public 方法

返回这一行动的惟一的ID在整个应用程序中。

public string getUniqueId ( )
return	string	这个行动的惟一的ID在整个应用程序中。

runWithParams() public 方法

这个动作用指定的参数运行。

这种方法主要是由控制器调用。

public mixed runWithParams ( $params )
$params	array	将参数绑定到行动的run()方法。
return	mixed	The result of the action
throws	yii\base\InvalidConfigException	如果action类没有run()方法