类 yii\filters\AccessRule
继承 | yii\filters\AccessRule » yii\base\Component » yii\base\BaseObject |
---|---|
实现 | yii\base\Configurable |
可用版本 | 2.0 |
源代码 | https://github.com/yiisoft/yii2/blob/master/framework/filters/AccessRule.php |
此类表示由 yii\filters\AccessControl 动作过滤器定义的访问规则。
公共属性
属性 | 类型 | 描述 | 定义于 |
---|---|---|---|
$actions | 数组|空 | 此规则适用的动作 ID 列表。 | yii\filters\AccessRule |
$allow | 布尔值 | 此规则是 "允许" 规则还是 "拒绝" 规则。 | yii\filters\AccessRule |
$behaviors | yii\base\Behavior[] | 附加到此组件的行为列表。 | yii\base\Component |
$controllers | 数组|空 | 此规则适用的控制器 ID 列表。 | yii\filters\AccessRule |
$denyCallback | 可调用|空 | 如果此规则确定应拒绝对当前动作的访问,则将调用此回调。 | yii\filters\AccessRule |
$ips | 数组|空 | 此规则适用的用户 IP 地址列表。 | yii\filters\AccessRule |
$matchCallback | 可调用 | 将调用此回调以确定是否应应用此规则。 | yii\filters\AccessRule |
$permissions | 数组|空 | 此规则适用的 RBAC(基于角色的访问控制)权限列表。 | yii\filters\AccessRule |
$roleParams | 数组|闭包 | 传递给 yii\web\User::can() 函数的参数,用于评估 $roles 中的用户权限。 | yii\filters\AccessRule |
$roles | 数组|空 | 此规则适用的角色列表(需要正确配置的用户组件)。 | yii\filters\AccessRule |
$verbs | 数组|空 | 此规则适用的请求方法(例如,GET 、POST )列表。 |
yii\filters\AccessRule |
公共方法
受保护方法
属性详情
此规则适用的控制器 ID 列表。
比较使用 yii\base\Controller::$uniqueId,因此每个控制器 ID 都以模块 ID(如果有)作为前缀。对于应用程序中的 product
控制器,您将像 ['product']
一样指定此属性,如果该控制器位于 shop
模块中,则将是 ['shop/product']
。
比较区分大小写。
如果未设置或为空,则表示此规则适用于所有控制器。
从版本 2.0.12 开始,控制器 ID 可以指定为通配符,例如 module/*
。
如果此规则确定应拒绝对当前操作的访问,则将调用此回调。当此规则匹配并且 $allow 设置为 false
时,就会出现这种情况。
如果未设置,则行为将由 yii\filters\AccessControl 确定,要么使用 yii\filters\AccessControl::denyAccess(),要么使用 yii\filters\AccessControl::$denyCallback(如果已配置)。
回调的签名应如下所示
function ($rule, $action)
其中 $rule
是此规则,$action
是当前 操作 对象。
此规则适用的用户 IP 地址列表。IP 地址可以在末尾包含通配符 *
,以便匹配具有相同前缀的 IP 地址。例如,'192.168.*' 匹配 '192.168.' 段中的所有 IP 地址。它还可以包含像 '172.16.0.0/12' 这样的模式/掩码,这将匹配 RFC1918 中 20 位私有网络块中的所有 IP。如果未设置或为空,则意味着此规则适用于所有 IP 地址。
另请参阅
将调用此回调以确定是否应应用该规则。回调的签名应如下所示
function ($rule, $action)
其中 $rule
是此规则,$action
是当前 操作 对象。回调应返回一个布尔值,指示是否应应用此规则。
传递给 yii\web\User::can() 函数的参数,用于评估 $roles 中的用户权限。
如果这是一个数组,它将直接传递给 yii\web\User::can()。例如,为了传递来自当前请求的 ID,您可以使用以下方法
['postId' => Yii::$app->request->get('id')]
您也可以指定一个返回数组的闭包。这可用于仅在需要时评估数组值,例如,当需要加载模型时,如以下代码所示
'rules' => [
[
'allow' => true,
'actions' => ['update'],
'roles' => ['updatePost'],
'roleParams' => function($rule) {
return ['post' => Post::findOne(Yii::$app->request->get('id'))];
},
],
],
对 yii\filters\AccessRule 实例的引用将作为第一个参数传递给闭包。
另请参阅 $roles。
此规则适用的角色列表(需要正确配置的用户组件)。两个特殊的角色被识别,它们通过 yii\web\User::$isGuest 检查
?
:匹配访客用户(尚未经过身份验证)@
:匹配经过身份验证的用户
如果您使用的是 RBAC(基于角色的访问控制),您也可以指定角色名称。在这种情况下, yii\web\User::can() 将被调用以检查访问权限。
请注意,最好检查权限。
如果此属性未设置或为空,则意味着此规则适用于任何角色。
另请参阅
此规则适用的请求方法(例如 GET
、POST
)列表。如果未设置或为空,则意味着此规则适用于所有请求方法。
另请参阅 yii\web\Request::$method。
方法详细信息
定义于: yii\base\Component::__call()
调用不是类方法的命名方法。
此方法将检查任何附加的行为是否具有命名方法,如果可用,将执行该方法。
不要直接调用此方法,因为它是一个 PHP 魔术方法,当调用未知方法时会隐式调用它。
public mixed __call ( $name, $params ) | ||
$name | string |
方法名称 |
$params | array |
方法参数 |
return | mixed |
方法返回值 |
---|---|---|
throws | 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()");
}
public void __clone ( ) |
public function __clone()
{
$this->_events = [];
$this->_eventWildcards = [];
$this->_behaviors = null;
}
定义于: yii\base\BaseObject::__construct()
构造函数。
默认实现执行两件事
- 使用给定的配置
$config
初始化对象。 - 调用 init()。
如果此方法在子类中被覆盖,建议
- 构造函数的最后一个参数是一个配置数组,如这里的
$config
。 - 在构造函数的末尾调用父实现。
public void __construct ( $config = [] ) | ||
$config | array |
将用于初始化对象属性的键值对 |
public function __construct($config = [])
{
if (!empty($config)) {
Yii::configure($this, $config);
}
$this->init();
}
Defined in: yii\base\Component::__get()
返回组件属性的值。
此方法将按以下顺序检查并相应地执行
- 由 getter 定义的属性:返回 getter 结果
- 行为的属性:返回行为的属性值
不要直接调用此方法,因为它是一个 PHP 魔术方法,它将在执行 $value = $component->property;
时被隐式调用。
另请参见 __set().
public mixed __get ( $name ) | ||
$name | string |
属性名称 |
return | mixed |
属性值或行为属性的值 |
---|---|---|
throws | yii\base\UnknownPropertyException |
如果属性未定义 |
throws | 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);
}
Defined in: yii\base\Component::__isset()
检查属性是否已设置,即已定义且不为空。
此方法将按以下顺序检查并相应地执行
- 由 setter 定义的属性:返回属性是否已设置
- 行为的属性:返回属性是否已设置
- 对于不存在的属性,返回
false
不要直接调用此方法,因为它是一个 PHP 魔术方法,它将在执行 isset($component->property)
时被隐式调用。
public boolean __isset ( $name ) | ||
$name | string |
属性名称或事件名称 |
return | 布尔值 |
命名的属性是否已设置 |
---|
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;
}
Defined in: yii\base\Component::__set()
设置组件属性的值。
此方法将按以下顺序检查并相应地执行
- 由 setter 定义的属性:设置属性值
- 以“on xyz”格式的事件:将处理程序附加到事件“xyz”
- 以“as xyz”格式的行为:附加名为“xyz”的行为
- 行为的属性:设置行为的属性值
不要直接调用此方法,因为它是一个 PHP 魔术方法,它将在执行 $component->property = $value;
时被隐式调用。
另请参见 __get().
public void __set ( $name, $value ) | ||
$name | string |
属性名称或事件名称 |
$value | mixed |
属性值 |
throws | yii\base\UnknownPropertyException |
如果属性未定义 |
---|---|---|
throws | 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);
}
Defined in: yii\base\Component::__unset()
将组件属性设置为 null。
此方法将按以下顺序检查并相应地执行
- 由 setter 定义的属性:将属性值设置为 null
- 行为的属性:将属性值设置为 null
不要直接调用此方法,因为它是一个 PHP 魔术方法,它将在执行 unset($component->property)
时被隐式调用。
public void __unset ( $name ) | ||
$name | string |
属性名称 |
throws | 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);
}
检查 Web 用户是否被允许执行指定的动作。
public boolean|null allows ( $action, $user, $request ) | ||
$action | yii\base\Action |
要执行的操作 |
$user | yii\web\User|false |
用户对象或 |
$request | yii\web\Request | |
return | boolean|null |
|
---|
public function allows($action, $user, $request)
{
if (
$this->matchAction($action)
&& $this->matchRole($user)
&& $this->matchIP($request->getUserIP())
&& $this->matchVerb($request->getMethod())
&& $this->matchController($action->controller)
&& $this->matchCustom($action)
) {
return $this->allow ? true : false;
}
return null;
}
Defined in: yii\base\Component::attachBehavior()
将行为附加到此组件。
此方法将根据给定的配置创建行为对象。之后,行为对象将通过调用 yii\base\Behavior::attach() 方法附加到此组件。
另请参见 detachBehavior().
public yii\base\Behavior attachBehavior ( $name, $behavior ) | ||
$name | string |
行为的名称。 |
$behavior | string|array|yii\base\Behavior |
行为配置。这可以是以下之一
|
return | yii\base\Behavior |
行为对象 |
---|
public function attachBehavior($name, $behavior)
{
$this->ensureBehaviors();
return $this->attachBehaviorInternal($name, $behavior);
}
Defined in: yii\base\Component::attachBehaviors()
将行为列表附加到组件。
每个行为都以其名称为索引,并且应该是一个 yii\base\Behavior 对象、一个指定行为类的字符串,或者一个用于创建行为的配置数组。
另请参见 attachBehavior().
public void attachBehaviors ( $behaviors ) | ||
$behaviors | array |
要附加到组件的行为列表 |
public function attachBehaviors($behaviors)
{
$this->ensureBehaviors();
foreach ($behaviors as $name => $behavior) {
$this->attachBehaviorInternal($name, $behavior);
}
}
Defined in: yii\base\Component::behaviors()
返回此组件应表现为的行为列表。
子类可以覆盖此方法来指定它们希望表现为的行为。
此方法的返回值应该是一个行为对象或配置的数组,以行为名称为索引。行为配置可以是指定行为类的字符串,也可以是以下结构的数组
'behaviorName' => [
'class' => 'BehaviorClass',
'property1' => 'value1',
'property2' => 'value2',
]
请注意,行为类必须扩展自 yii\base\Behavior。行为可以使用名称或匿名附加。当使用名称作为数组键时,使用此名称,行为可以稍后使用 getBehavior() 检索,或者使用 detachBehavior() 分离。匿名行为无法检索或分离。
在此方法中声明的行为将自动(按需)附加到组件。
public array behaviors ( ) | ||
return | array |
行为配置。 |
---|
public function behaviors()
{
return [];
}
Defined in: yii\base\Component::canGetProperty()
返回一个值,指示是否可以读取属性。
如果满足以下条件,则可以读取属性
- 如果类具有与指定名称关联的 getter 方法(在本例中,属性名称不区分大小写);
- 类具有与指定名称关联的成员变量(当
$checkVars
为真时); - 附加的行为具有给定名称的可读属性(当
$checkBehaviors
为真时)。
另请参见 canSetProperty().
public boolean canGetProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string |
属性名称 |
$checkVars | 布尔值 |
是否将成员变量视为属性 |
$checkBehaviors | 布尔值 |
是否将行为的属性视为该组件的属性 |
return | 布尔值 |
属性是否可读 |
---|
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;
}
定义于: yii\base\Component::canSetProperty()
返回一个值,指示是否可以设置属性。
属性可以写入,如果
- 类具有与指定名称关联的 setter 方法(在本例中,属性名称不区分大小写);
- 类具有与指定名称关联的成员变量(当
$checkVars
为真时); - 附加的行为具有给定名称的可写属性(当
$checkBehaviors
为真时)。
另请参见 canGetProperty().
public boolean canSetProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string |
属性名称 |
$checkVars | 布尔值 |
是否将成员变量视为属性 |
$checkBehaviors | 布尔值 |
是否将行为的属性视为该组件的属性 |
return | 布尔值 |
属性是否可写 |
---|
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;
}
::class
代替。
定义于: yii\base\BaseObject::className()
返回此类的完全限定名称。
public static string className ( ) | ||
return | string |
此类的完全限定名称。 |
---|
public static function className()
{
return get_called_class();
}
public yii\base\Behavior|null detachBehavior ( $name ) | ||
$name | string |
行为的名称。 |
return | 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;
}
定义于: yii\base\Component::detachBehaviors()
从组件中分离所有行为。
public void detachBehaviors ( ) |
public function detachBehaviors()
{
$this->ensureBehaviors();
foreach ($this->_behaviors as $name => $behavior) {
$this->detachBehavior($name);
}
}
定义于: 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);
}
}
}
定义于: yii\base\Component::getBehavior()
返回命名行为对象。
public yii\base\Behavior|null getBehavior ( $name ) | ||
$name | string |
行为名称 |
return | yii\base\Behavior|null |
行为对象,如果行为不存在则为 null |
---|
public function getBehavior($name)
{
$this->ensureBehaviors();
return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}
定义于: yii\base\Component::getBehaviors()
返回附加到此组件的所有行为。
public yii\base\Behavior[] getBehaviors ( ) | ||
return | yii\base\Behavior[] |
附加到此组件的行为列表 |
---|
public function getBehaviors()
{
$this->ensureBehaviors();
return $this->_behaviors;
}
定义于: yii\base\Component::hasEventHandlers()
返回一个值,指示命名事件是否有任何处理程序附加。
public boolean hasEventHandlers ( $name ) | ||
$name | string |
事件名称 |
return | 布尔值 |
事件是否附加了任何处理程序。 |
---|
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);
}
定义于: yii\base\Component::hasMethod()
返回一个值,指示是否定义了方法。
方法被定义,如果
- 类具有与指定名称关联的方法
- 附加的行为具有给定名称的方法(当
$checkBehaviors
为真时)。
public boolean hasMethod ( $name, $checkBehaviors = true ) | ||
$name | string |
属性名称 |
$checkBehaviors | 布尔值 |
是否将行为的方法视为该组件的方法 |
return | 布尔值 |
方法是否被定义 |
---|
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;
}
定义于: yii\base\Component::hasProperty()
返回一个值,指示是否为此组件定义了属性。
属性被定义,如果
- 类具有与指定名称关联的 getter 或 setter 方法(在本例中,属性名称不区分大小写);
- 类具有与指定名称关联的成员变量(当
$checkVars
为真时); - 附加的行为具有给定名称的属性(当
$checkBehaviors
为真时)。
另请参阅
public boolean hasProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string |
属性名称 |
$checkVars | 布尔值 |
是否将成员变量视为属性 |
$checkBehaviors | 布尔值 |
是否将行为的属性视为该组件的属性 |
return | 布尔值 |
属性是否被定义 |
---|
public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}
public void init ( ) |
public function init()
{
}
protected boolean matchAction ( $action ) | ||
$action | yii\base\Action |
操作 |
return | 布尔值 |
规则是否适用于该操作 |
---|
protected function matchAction($action)
{
return empty($this->actions) || in_array($action->id, $this->actions, true);
}
protected boolean matchController ( $controller ) | ||
$controller | yii\base\Controller |
控制器 |
return | 布尔值 |
规则是否适用于该控制器 |
---|
protected function matchController($controller)
{
if (empty($this->controllers)) {
return true;
}
$id = $controller->getUniqueId();
foreach ($this->controllers as $pattern) {
if (StringHelper::matchWildcard($pattern, $id)) {
return true;
}
}
return false;
}
protected boolean matchCustom ( $action ) | ||
$action | yii\base\Action |
要执行的操作 |
return | 布尔值 |
规则是否应该应用 |
---|
protected function matchCustom($action)
{
return empty($this->matchCallback) || call_user_func($this->matchCallback, $this, $action);
}
protected boolean matchIP ( $ip ) | ||
$ip | string|null |
IP 地址 |
return | 布尔值 |
规则是否适用于该 IP 地址 |
---|
protected function matchIP($ip)
{
if (empty($this->ips)) {
return true;
}
foreach ($this->ips as $rule) {
if (
$rule === '*'
|| $rule === $ip
|| (
$ip !== null
&& ($pos = strpos($rule, '*')) !== false
&& strncmp($ip, $rule, $pos) === 0
)
|| (
strpos($rule, '/') !== false
&& IpHelper::inRange($ip, $rule) === true
)
) {
return true;
}
}
return false;
}
protected boolean matchRole ( $user ) | ||
$user | yii\web\User |
用户对象 |
return | 布尔值 |
规则是否适用于该角色 |
---|---|---|
throws | yii\base\InvalidConfigException |
如果用户组件已分离 |
protected function matchRole($user)
{
$items = empty($this->roles) ? [] : $this->roles;
if (!empty($this->permissions)) {
$items = array_merge($items, $this->permissions);
}
if (empty($items)) {
return true;
}
if ($user === false) {
throw new InvalidConfigException('The user application component must be available to specify roles in AccessRule.');
}
foreach ($items as $item) {
if ($item === '?') {
if ($user->getIsGuest()) {
return true;
}
} elseif ($item === '@') {
if (!$user->getIsGuest()) {
return true;
}
} else {
if (!isset($roleParams)) {
$roleParams = !is_array($this->roleParams) && is_callable($this->roleParams) ? call_user_func($this->roleParams, $this) : $this->roleParams;
}
if ($user->can($item, $roleParams)) {
return true;
}
}
}
return false;
}
protected boolean matchVerb ( $verb ) | ||
$verb | string |
请求方法。 |
return | 布尔值 |
规则是否适用于该请求 |
---|
protected function matchVerb($verb)
{
return empty($this->verbs) || in_array(strtoupper($verb), array_map('strtoupper', $this->verbs), true);
}
定义于: yii\base\Component::off()
从此组件中分离现有的事件处理程序。
此方法与 on() 相反。
注意:如果为事件名传递了通配符模式,则只会删除使用此通配符注册的处理程序,而使用与该通配符匹配的纯名称注册的处理程序将保留。
另请参阅 on()。
public boolean off ( $name, $handler = null ) | ||
$name | string |
事件名称 |
$handler | 可调用|空 |
要删除的事件处理程序。如果为 null,则将删除附加到指定事件的所有处理程序。 |
return | 布尔值 |
如果找到并分离了处理程序 |
---|
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;
}
将事件处理程序附加到事件。
事件处理程序必须是一个有效的 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 | mixed |
触发事件时传递给事件处理程序的数据。调用事件处理程序时,可以通过 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]);
}
}
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);
}
注册 或 登录 以发表评论。