Class yii\base\Action

继承yii\base\Action » yii\base\Component » yii\base\BaseObject
实现yii\base\Configurable
子类yii\base\InlineAction, yii\captcha\CaptchaAction, yii\rest\Action, yii\rest\CreateAction, yii\rest\DeleteAction, yii\rest\IndexAction, yii\rest\OptionsAction, yii\rest\UpdateAction, yii\rest\ViewAction, yii\web\ErrorAction, yii\web\ViewAction
可用自版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/base/Action.php

Action 是所有控制器动作类的基类.

Action 提供了一种重用动作方法代码的方法. Action 类中的action方法可以在多个控制器多不同项目中使用.

派生类必须实现一个名为run()的方法. 当请求动作时, 控制器将调用此方法. run()方法可以包含一些参数, 这些参数将根据用户输入的名称自动填充. 例如, 如果run()方法声明如下:

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

为动作提供的参数为: ['id' => 1]. 然后, 将自动将run()方法作为run(1)调用.

有关 Action 的更多详细信息和用法信息, 请参见 guide article on actions.

公共属性

隐藏继承的属性

属性类型描述定义在
$behaviors yii\base\Behavior[] 附加到此组件的行为列表. 该属性是只读的. yii\base\Component
$controller yii\base\Controller|yii\web\Controller|yii\console\Controller 拥有此动作的控制器. yii\base\Action
$id string 动作 ID. yii\base\Action
$uniqueId string 整个应用程序中此动作的唯一 ID. 该属性是只读的. yii\base\Action

公共方法

隐藏继承的方法

方法描述定义在
__call() 调用不是类方法的已命名方法. yii\base\BaseObject
__clone() 在通过克隆现有对象创建对象之后调用此方法. yii\base\Component
__construct() 构造函数. yii\base\Action
__get() 返回对象属性的值. yii\base\BaseObject
__isset() 检查属性是否已设置, 即已定义且不为null. yii\base\BaseObject
__set() 设置对象属性的值. yii\base\BaseObject
__unset() 将对象属性设置为null. yii\base\BaseObject
attachBehavior() 将行为附加到此组件. yii\base\Component
attachBehaviors() 将行为列表附加到组件. yii\base\Component
behaviors() 返回此组件应该具有的行为列表. yii\base\Component
canGetProperty() 返回一个值, 指示属性是否可读. yii\base\BaseObject
canSetProperty() 返回一个值, 指示属性是否可写. yii\base\BaseObject
className() 返回此类的完全限定名称. yii\base\BaseObject
detachBehavior() 从组件中分离一个行为. yii\base\Component
detachBehaviors() 分离组件中的所有行为. yii\base\Component
ensureBehaviors() 确保在 behaviors() 中声明的行为已附加到此组件. yii\base\Component
getBehavior() 返回指定的行为对象. yii\base\Component
getBehaviors() 返回附加到此组件的所有行为. yii\base\Component
getUniqueId() 返回整个应用程序中此动作的唯一 ID. yii\base\Action
hasEventHandlers() 返回一个值, 指示是否有任何处理程序附加到指定的事件. yii\base\Component
hasMethod() 返回一个值, 指示方法是否已定义. yii\base\BaseObject
hasProperty() 返回一个值, 指示属性是否已定义. yii\base\BaseObject
init() 初始化对象. yii\base\BaseObject
off() 从该组件分离现有的事件处理程序. yii\base\Component
on() 将事件处理程序附加到事件. yii\base\Component
runWithParams() 使用指定的参数运行此动作. yii\base\Action
trigger() 触发事件. yii\base\Component

受保护的方法

隐藏继承的方法

方法描述定义在
afterRun() 在执行run()之后立即调用此方法. yii\base\Action
beforeRun() 在执行run()之前立即调用此方法. yii\base\Action

属性详情

$controller public 属性

拥有此动作的控制器.

$id public 属性

动作 ID.

public string $id null
$uniqueId public 属性

整个应用程序中此动作的唯一 ID. 该属性是只读的.

public string $uniqueId null

方法详情

__construct() public 方法

构造函数.

public void __construct ( $id, $controller, $config = [] )
$id string

该动作的 ID.

$controller yii\base\Controller

拥有此动作的控制器.

$config array

将用于初始化对象属性的name-value对.

afterRun() protected 方法

在执行run()之后立即调用此方法.

你可以重写此方法来为动作运行做后续处理.

protected void afterRun ( )
beforeRun() protected 方法

在执行run()之前立即调用此方法.

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

protected boolean beforeRun ( )
return boolean

Whether to run the action.

getUniqueId() public 方法

返回整个应用程序中此动作的唯一 ID.

public string getUniqueId ( )
return string

整个应用程序中此动作的唯一 ID.

runWithParams() public 方法

使用指定的参数运行此动作.

此方法主要由控制器调用.

public mixed runWithParams ( $params )
$params array

要绑定到动作的run()方法的参数.

return mixed

动作的结果.

throws yii\base\InvalidConfigException

如果操作类没有run方法.