1 关注者

类 yii\rest\Action

所有类 | 属性 | 方法
继承关系yii\rest\Action » yii\base\Action » yii\base\Component » yii\base\BaseObject
实现接口yii\base\Configurable
子类yii\rest\CreateAction, yii\rest\DeleteAction, yii\rest\IndexAction, yii\rest\UpdateAction, yii\rest\ViewAction
可用版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/rest/Action.php

Action 是实现 RESTful API 的操作类基类。

有关 Action 的更多详细信息和用法信息，请参阅 关于 REST 控制器指南文章。

公共属性

隐藏继承属性

属性 类型 描述 定义于
$behaviors yii\base\Behavior[] 附加到此组件的行为列表。 yii\base\Component
$checkAccess callable|null 在运行操作时将调用的 PHP 可调用对象，以确定当前用户是否具有执行操作的权限。 yii\rest\Action
$controller yii\base\Controller|yii\web\Controller|yii\console\Controller 拥有此操作的控制器 yii\base\Action
$findModel callable|null 将调用的 PHP 可调用对象，以返回与指定主键值对应的模型。 yii\rest\Action
$id string 操作的 ID yii\base\Action
$modelClass string 将由此操作处理的模型的类名。 yii\rest\Action
$uniqueId string 此操作在整个应用程序中的唯一 ID。 yii\base\Action

公共方法

隐藏继承方法

方法 描述 定义于
__call() 调用不是类方法的命名方法。 yii\base\Component
__clone() 此方法在通过克隆现有对象创建对象后调用。 yii\base\Component
__construct() 构造函数。 yii\base\Action
__get() 返回组件属性的值。 yii\base\Component
__isset() 检查属性是否已设置，即定义且不为 null。 yii\base\Component
__set() 设置组件属性的值。 yii\base\Component
__unset() 将组件属性设置为 null。 yii\base\Component
attachBehavior() 将行为附加到此组件。 yii\base\Component
attachBehaviors() 将行为列表附加到组件。 yii\base\Component
behaviors() 返回此组件应表现为的行为列表。 yii\base\Component
canGetProperty() 返回一个值，指示是否可以读取属性。 yii\base\Component
canSetProperty() 返回一个值，指示是否可以设置属性。 yii\base\Component
className() 返回此类的完全限定名称。 yii\base\BaseObject
detachBehavior() 从组件中分离行为。 yii\base\Component
detachBehaviors() 从组件中分离所有行为。 yii\base\Component
ensureBehaviors() 确保在 behaviors() 中声明的行为已附加到此组件。 yii\base\Component
findModel() 根据给定的主键返回数据模型。 yii\rest\Action
getBehavior() 返回命名的行为对象。 yii\base\Component
getBehaviors() 返回附加到此组件的所有行为。 yii\base\Component
getUniqueId() 返回此操作在整个应用程序中的唯一 ID。 yii\base\Action
hasEventHandlers() 返回一个值，指示是否有任何处理程序附加到命名的事件。 yii\base\Component
hasMethod() 返回一个值，指示方法是否已定义。 yii\base\Component
hasProperty() 返回一个值，指示此组件是否定义了属性。 yii\base\Component
init() 初始化对象。 yii\rest\Action
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

属性详情

隐藏继承属性

$checkAccess 公共属性

在运行操作时将调用的 PHP 可调用对象，以确定当前用户是否具有执行操作的权限。如果未设置，则不会执行访问检查。可调用对象的签名应如下所示：

function ($action, $model = null) {
    // $model is the requested model instance.
    // If null, it means no specific model (e.g. IndexAction)
}
public callable|null $checkAccess = null
$findModel 公共属性

将调用的 PHP 可调用对象，以返回与指定主键值对应的模型。如果未设置，则将使用 findModel()。可调用对象的签名应为

function ($id, $action) {
    // $id is the primary key value. If composite primary key, the key values
    // will be separated by comma.
    // $action is the action object currently running
}

可调用对象应返回找到的模型，如果未找到则抛出异常。

public callable|null $findModel = null
$modelClass 公共属性

将由此操作处理的模型的类名。模型类必须实现 yii\db\ActiveRecordInterface。此属性必须设置。

public string $modelClass = null

方法详情

隐藏继承方法

__call() 公共方法

定义于： yii\base\Component::__call()

调用不是类方法的命名方法。

此方法将检查任何附加的行为是否具有指定名称的方法，并在可用时执行该方法。

不要直接调用此方法，因为它是一个 PHP 魔术方法，当调用未知方法时会隐式调用。

public mixed __call ( $name, $params )
$name string

方法名称
$params 数组

方法参数
返回值 混合类型

方法返回值
抛出异常 yii\base\UnknownMethodException

调用未知方法时

 

                public function __call($name, $params)
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $object) {
        if ($object->hasMethod($name)) {
            return call_user_func_array([$object, $name], $params);
        }
    }
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
__clone() 公共方法

定义于： yii\base\Component::__clone()

此方法在通过克隆现有对象创建对象后调用。

它会移除所有行为，因为它们附加到旧对象上。

public void __clone ( )

                public function __clone()
{
    $this->_events = [];
    $this->_eventWildcards = [];
    $this->_behaviors = null;
}
__construct() 公共方法

定义于： yii\base\Action::__construct()

构造函数。

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

此操作的 ID
$controller yii\base\Controller

拥有此操作的控制器
$config 数组

用于初始化对象属性的名称-值对

 

                public function __construct($id, $controller, $config = [])
{
    $this->id = $id;
    $this->controller = $controller;
    parent::__construct($config);
}
__get() 公共方法

定义于： yii\base\Component::__get()

返回组件属性的值。

此方法将按照以下顺序检查并相应地执行

  • 由 getter 定义的属性：返回 getter 的结果
  • 行为的属性：返回行为属性的值

不要直接调用此方法，因为它是一个 PHP 魔术方法，当执行 $value = $component->property; 时会隐式调用。

另请参阅 __set()。

public mixed __get ( $name )
$name string

属性名称
返回值 混合类型

属性值或行为属性的值
抛出异常 yii\base\UnknownPropertyException

如果未定义属性
抛出异常 yii\base\InvalidCallException

如果属性是只写属性。

 

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        // read property, e.g. getName()
        return $this->$getter();
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name;
        }
    }
    if (method_exists($this, 'set' . $name)) {
        throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
__isset() 公共方法

定义于： yii\base\Component::__isset()

检查属性是否已设置，即定义且不为 null。

此方法将按照以下顺序检查并相应地执行

  • 由 setter 定义的属性：返回属性是否已设置
  • 行为的属性：返回属性是否已设置
  • 对于不存在的属性返回 false

不要直接调用此方法，因为它是一个 PHP 魔术方法，当执行 isset($component->property) 时会隐式调用。

另请参阅 https://php.ac.cn/manual/en/function.isset.php。

public boolean __isset ( $name )
$name string

属性名称或事件名称
返回值 布尔值

指定的属性是否已设置

 

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name !== null;
        }
    }
    return false;
}
__set() 公共方法

定义于： yii\base\Component::__set()

设置组件属性的值。

此方法将按照以下顺序检查并相应地执行

  • 由 setter 定义的属性：设置属性值
  • 格式为“on xyz”的事件：将处理程序附加到事件“xyz”
  • 格式为“as xyz”的行为：附加名为“xyz”的行为
  • 行为的属性：设置行为属性的值

不要直接调用此方法，因为它是一个 PHP 魔术方法，当执行 $component->property = $value; 时会隐式调用。

另请参阅 __get()。

public void __set ( $name, $value )
$name string

属性名称或事件名称
$value 混合类型

属性值
抛出异常 yii\base\UnknownPropertyException

如果未定义属性
抛出异常 yii\base\InvalidCallException

如果属性是只读属性。

 

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        // set property
        $this->$setter($value);
        return;
    } elseif (strncmp($name, 'on ', 3) === 0) {
        // on event: attach event handler
        $this->on(trim(substr($name, 3)), $value);
        return;
    } elseif (strncmp($name, 'as ', 3) === 0) {
        // as behavior: attach behavior
        $name = trim(substr($name, 3));
        $this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = $value;
            return;
        }
    }
    if (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}
__unset() 公共方法

定义于： yii\base\Component::__unset()

将组件属性设置为 null。

此方法将按照以下顺序检查并相应地执行

  • 由 setter 定义的属性：将属性值设置为 null
  • 行为的属性：将属性值设置为 null

不要直接调用此方法，因为它是一个 PHP 魔术方法，当执行 unset($component->property) 时会隐式调用。

另请参阅 https://php.ac.cn/manual/en/function.unset.php。

public void __unset ( $name )
$name string

属性名称
抛出异常 yii\base\InvalidCallException

如果属性是只读属性。

 

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = null;
            return;
        }
    }
    throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
}
afterRun() 受保护方法

定义于： yii\base\Action::afterRun()

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

您可以重写此方法以对操作运行执行后处理工作。

protected void afterRun ( )

                protected function afterRun()
{
}
attachBehavior() 公共方法

定义于： yii\base\Component::attachBehavior()

将行为附加到此组件。

此方法将根据给定的配置创建行为对象。之后，行为对象将通过调用 yii\base\Behavior::attach() 方法附加到此组件。

另请参阅 detachBehavior()。

public yii\base\Behavior attachBehavior ( $name, $behavior )
$name string

行为的名称。
$behavior string|array|yii\base\Behavior

行为配置。可以是以下之一
返回值 yii\base\Behavior

行为对象

 

                public function attachBehavior($name, $behavior)
{
    $this->ensureBehaviors();
    return $this->attachBehaviorInternal($name, $behavior);
}
attachBehaviors() 公共方法

定义于： yii\base\Component::attachBehaviors()

将行为列表附加到组件。

每个行为都由其名称索引，并且应该是一个 yii\base\Behavior 对象、一个指定行为类的字符串或一个用于创建行为的配置数组。

另请参阅 attachBehavior()。

public void attachBehaviors ( $behaviors )
$behaviors 数组

要附加到组件的行为列表

 

                public function attachBehaviors($behaviors)
{
    $this->ensureBehaviors();
    foreach ($behaviors as $name => $behavior) {
        $this->attachBehaviorInternal($name, $behavior);
    }
}
beforeRun() 受保护方法

定义于： yii\base\Action::beforeRun()

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

您可以重写此方法来为操作运行做准备工作。如果此方法返回 false，则会取消操作。

protected boolean beforeRun ( )
返回值 布尔值

是否运行操作。

 

                protected function beforeRun()
{
    return true;
}
behaviors() 公共方法

定义于： yii\base\Component::behaviors()

返回此组件应表现为的行为列表。

子类可以重写此方法来指定它们希望表现出的行为。

此方法的返回值应该是一个行为对象或配置的数组，并以行为名称为索引。行为配置可以是指定行为类的字符串，也可以是以下结构的数组

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

请注意，行为类必须扩展自 yii\base\Behavior。行为可以使用名称或匿名方式附加。当数组键使用名称时，可以使用此名称，稍后可以使用 getBehavior() 检索行为，或使用 detachBehavior() 分离行为。匿名行为无法检索或分离。

在此方法中声明的行为将自动附加到组件（按需）。

public array behaviors ( )
返回值 数组

行为配置。

 

                public function behaviors()
{
    return [];
}
canGetProperty() 公共方法

定义于： yii\base\Component::canGetProperty()

返回一个值，指示是否可以读取属性。

如果可以读取属性，则

  • 类具有与指定名称关联的 getter 方法（在这种情况下，属性名称不区分大小写）；
  • 类具有与指定名称相同的成员变量（当 $checkVars 为 true 时）；
  • 附加的行为具有给定名称的可读属性（当 $checkBehaviors 为 true 时）。

另请参见 canSetProperty()。

public boolean canGetProperty ( $name, $checkVars = true, $checkBehaviors = true )
$name string

属性名称
$checkVars 布尔值

是否将成员变量视为属性
$checkBehaviors 布尔值

是否将行为的属性视为此组件的属性
返回值 布尔值

属性是否可读

 

                public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canGetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}
canSetProperty() 公共方法

定义于： yii\base\Component::canSetProperty()

返回一个值，指示是否可以设置属性。

如果可以写入属性，则

  • 类具有与指定名称关联的 setter 方法（在这种情况下，属性名称不区分大小写）；
  • 类具有与指定名称相同的成员变量（当 $checkVars 为 true 时）；
  • 附加的行为具有给定名称的可写属性（当 $checkBehaviors 为 true 时）。

另请参见 canGetProperty()。

public boolean canSetProperty ( $name, $checkVars = true, $checkBehaviors = true )
$name string

属性名称
$checkVars 布尔值

是否将成员变量视为属性
$checkBehaviors 布尔值

是否将行为的属性视为此组件的属性
返回值 布尔值

属性是否可写

 

                public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canSetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}
className() 公共静态方法
自 2.0.14 版本起已弃用。在 PHP >=5.5 上，请改用 ::class。

定义于： yii\base\BaseObject::className()

返回此类的完全限定名称。

public static string className ( )
返回值 string

此类的完全限定名称。

 

                public static function className()
{
    return get_called_class();
}
detachBehavior() 公共方法

定义于： yii\base\Component::detachBehavior()

从组件中分离行为。

将调用行为的 yii\base\Behavior::detach() 方法。

public yii\base\Behavior|null detachBehavior ( $name )
$name string

行为的名称。
返回值 yii\base\Behavior|null

已分离的行为。如果行为不存在，则为 Null。

 

                public function detachBehavior($name)
{
    $this->ensureBehaviors();
    if (isset($this->_behaviors[$name])) {
        $behavior = $this->_behaviors[$name];
        unset($this->_behaviors[$name]);
        $behavior->detach();
        return $behavior;
    }
    return null;
}
detachBehaviors() 公共方法

定义于： yii\base\Component::detachBehaviors()

从组件中分离所有行为。

public void detachBehaviors ( )

                public function detachBehaviors()
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $name => $behavior) {
        $this->detachBehavior($name);
    }
}
ensureBehaviors() 公共方法

定义于： yii\base\Component::ensureBehaviors()

确保在 behaviors() 中声明的行为已附加到此组件。

public void ensureBehaviors ( )

                public function ensureBehaviors()
{
    if ($this->_behaviors === null) {
        $this->_behaviors = [];
        foreach ($this->behaviors() as $name => $behavior) {
            $this->attachBehaviorInternal($name, $behavior);
        }
    }
}
findModel() 公共方法

根据给定的主键返回数据模型。

如果未找到数据模型，则会引发 404 HTTP 异常。

public yii\db\ActiveRecordInterface findModel ( $id )
$id string

要加载的模型的 ID。如果模型具有复合主键，则 ID 必须是主键值的字符串，并用逗号分隔。主键值的顺序应遵循模型的 primaryKey() 方法返回的顺序。
返回值 yii\db\ActiveRecordInterface

找到的模型
抛出异常 yii\web\NotFoundHttpException

如果找不到模型

 

                public function findModel($id)
{
    if ($this->findModel !== null) {
        return call_user_func($this->findModel, $id, $this);
    }
    /* @var $modelClass ActiveRecordInterface */
    $modelClass = $this->modelClass;
    $keys = $modelClass::primaryKey();
    if (count($keys) > 1) {
        $values = explode(',', $id);
        if (count($keys) === count($values)) {
            $model = $modelClass::findOne(array_combine($keys, $values));
        }
    } elseif ($id !== null) {
        $model = $modelClass::findOne($id);
    }
    if (isset($model)) {
        return $model;
    }
    throw new NotFoundHttpException("Object not found: $id");
}
getBehavior() 公共方法

定义于： yii\base\Component::getBehavior()

返回命名的行为对象。

public yii\base\Behavior|null getBehavior ( $name )
$name string

行为名称
返回值 yii\base\Behavior|null

行为对象，如果行为不存在则为 null

 

                public function getBehavior($name)
{
    $this->ensureBehaviors();
    return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}
getBehaviors() 公共方法

定义于： yii\base\Component::getBehaviors()

返回附加到此组件的所有行为。

public yii\base\Behavior[] getBehaviors ( )
返回值 yii\base\Behavior[]

附加到此组件的行为列表

 

                public function getBehaviors()
{
    $this->ensureBehaviors();
    return $this->_behaviors;
}
getUniqueId() 公共方法

定义于： yii\base\Action::getUniqueId()

返回此操作在整个应用程序中的唯一 ID。

public string getUniqueId ( )
返回值 string

此操作在整个应用程序中的唯一 ID。

 

                public function getUniqueId()
{
    return $this->controller->getUniqueId() . '/' . $this->id;
}
hasEventHandlers() 公共方法

定义于： yii\base\Component::hasEventHandlers()

返回一个值，指示是否有任何处理程序附加到命名的事件。

public boolean hasEventHandlers ( $name )
$name string

事件名称
返回值 布尔值

是否存在任何附加到事件的处理程序。

 

                public function hasEventHandlers($name)
{
    $this->ensureBehaviors();
    if (!empty($this->_events[$name])) {
        return true;
    }
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
            return true;
        }
    }
    return Event::hasHandlers($this, $name);
}
hasMethod() 公共方法

定义于： yii\base\Component::hasMethod()

返回一个值，指示方法是否已定义。

如果定义了方法

  • 该类具有指定名称的方法
  • 附加的行为具有给定名称的方法（当 $checkBehaviors 为 true 时）。
public boolean hasMethod ( $name, $checkBehaviors = true )
$name string

属性名称
$checkBehaviors 布尔值

是否将行为的方法视为此组件的方法
返回值 布尔值

方法是否已定义

 

                public function hasMethod($name, $checkBehaviors = true)
{
    if (method_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->hasMethod($name)) {
                return true;
            }
        }
    }
    return false;
}
hasProperty() 公共方法

定义于： yii\base\Component::hasProperty()

返回一个值，指示此组件是否定义了属性。

如果定义了属性

  • 该类具有与指定名称关联的 getter 或 setter 方法（在这种情况下，属性名称不区分大小写）；
  • 类具有与指定名称相同的成员变量（当 $checkVars 为 true 时）；
  • 附加的行为具有给定名称的属性（当 $checkBehaviors 为 true 时）。

另请参阅

public boolean hasProperty ( $name, $checkVars = true, $checkBehaviors = true )
$name string

属性名称
$checkVars 布尔值

是否将成员变量视为属性
$checkBehaviors 布尔值

是否将行为的属性视为此组件的属性
返回值 布尔值

属性是否已定义

 

                public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
    return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}
init() 公共方法

初始化对象。

此方法在构造函数结束时调用，在对象使用给定配置初始化后调用。

public void init ( )

                public function init()
{
    if ($this->modelClass === null) {
        throw new InvalidConfigException(get_class($this) . '::$modelClass must be set.');
    }
}
off() 公共方法

定义于： yii\base\Component::off()

从此组件中分离现有的事件处理程序。

此方法与 on() 相反。

注意：如果为事件名称传递了通配符模式，则只会删除使用此通配符注册的处理程序，而使用与该通配符匹配的普通名称注册的处理程序将保留。

另请参阅 on()。

public boolean off ( $name, $handler = null )
$name string

事件名称
$handler callable|null

要移除的事件处理程序。如果为 null，则会移除附加到命名事件的所有处理程序。
返回值 布尔值

如果找到并分离了一个处理程序

 

                public function off($name, $handler = null)
{
    $this->ensureBehaviors();
    if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
        return false;
    }
    if ($handler === null) {
        unset($this->_events[$name], $this->_eventWildcards[$name]);
        return true;
    }
    $removed = false;
    // plain event names
    if (isset($this->_events[$name])) {
        foreach ($this->_events[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_events[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_events[$name] = array_values($this->_events[$name]);
            return true;
        }
    }
    // wildcard event names
    if (isset($this->_eventWildcards[$name])) {
        foreach ($this->_eventWildcards[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_eventWildcards[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
            // remove empty wildcards to save future redundant regex checks:
            if (empty($this->_eventWildcards[$name])) {
                unset($this->_eventWildcards[$name]);
            }
        }
    }
    return $removed;
}
on() 公共方法

定义于： yii\base\Component::on()

将事件处理程序附加到事件。

事件处理程序必须是有效的 PHP 回调。以下是一些示例

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

事件处理程序必须使用以下签名定义，

function ($event)

其中 $event 是一个 yii\base\Event 对象，其中包含与事件关联的参数。

从 2.0.14 开始，您可以将事件名称指定为通配符模式

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});

另请参阅 off()。

public void on ( $name, $handler, $data = null, $append = true )
$name string

事件名称
$handler 可调用

事件处理程序
$data 混合类型

触发事件时传递给事件处理程序的数据。调用事件处理程序时，可以通过 yii\base\Event::$data 访问此数据。
$append 布尔值

是否将新的事件处理程序附加到现有处理程序列表的末尾。如果为 false，则新的处理程序将插入到现有处理程序列表的开头。

 

                public function on($name, $handler, $data = null, $append = true)
{
    $this->ensureBehaviors();
    if (strpos($name, '*') !== false) {
        if ($append || empty($this->_eventWildcards[$name])) {
            $this->_eventWildcards[$name][] = [$handler, $data];
        } else {
            array_unshift($this->_eventWildcards[$name], [$handler, $data]);
        }
        return;
    }
    if ($append || empty($this->_events[$name])) {
        $this->_events[$name][] = [$handler, $data];
    } else {
        array_unshift($this->_events[$name], [$handler, $data]);
    }
}
runWithParams() 公共方法

定义于： yii\base\Action::runWithParams()

使用指定的参数运行此操作。

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

public mixed runWithParams ( $params )
$params 数组

要绑定到操作的 run() 方法的参数。
返回值 混合类型

操作的结果
抛出异常 yii\base\InvalidConfigException

如果操作类没有 run() 方法

 

                public function runWithParams($params)
{
    if (!method_exists($this, 'run')) {
        throw new InvalidConfigException(get_class($this) . ' must define a "run()" method.');
    }
    $args = $this->controller->bindActionParams($this, $params);
    Yii::debug('Running action: ' . get_class($this) . '::run(), invoked by ' . get_class($this->controller), __METHOD__);
    if (Yii::$app->requestedParams === null) {
        Yii::$app->requestedParams = $args;
    }
    if ($this->beforeRun()) {
        $result = call_user_func_array([$this, 'run'], $args);
        $this->afterRun();
        return $result;
    }
    return null;
}
trigger() 公共方法

定义于： yii\base\Component::trigger()

触发事件。

此方法表示事件的发生。它调用事件的所有附加处理程序，包括类级处理程序。

public void trigger ( $name, yii\base\Event $event = null )
$name string

事件名称
$event yii\base\Event|null

事件实例。如果未设置，则会创建一个默认的 yii\base\Event 对象。

 

                public function trigger($name, Event $event = null)
{
    $this->ensureBehaviors();
    $eventHandlers = [];
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (StringHelper::matchWildcard($wildcard, $name)) {
            $eventHandlers[] = $handlers;
        }
    }
    if (!empty($this->_events[$name])) {
        $eventHandlers[] = $this->_events[$name];
    }
    if (!empty($eventHandlers)) {
        $eventHandlers = call_user_func_array('array_merge', $eventHandlers);
        if ($event === null) {
            $event = new Event();
        }
        if ($event->sender === null) {
            $event->sender = $this;
        }
        $event->handled = false;
        $event->name = $name;
        foreach ($eventHandlers as $handler) {
            $event->data = $handler[1];
            call_user_func($handler[0], $event);
            // stop further handling if the event is handled
            if ($event->handled) {
                return;
            }
        }
    }
    // invoke class-level attached handlers
    Event::trigger($this, $name, $event);
}