1 关注者

类 yii\filters\AccessControl

所有类 | 属性 | 方法
继承关系yii\filters\AccessControl » yii\base\ActionFilter » yii\base\Behavior » yii\base\BaseObject
实现接口yii\base\Configurable
可用版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/filters/AccessControl.php

AccessControl 基于一组规则提供简单的访问控制。

AccessControl 是一个 action 过滤器。它将检查其 $rules 以查找第一个与当前上下文变量（例如用户 IP 地址、用户角色）匹配的规则。匹配的规则将决定是否允许或拒绝对请求的控制器操作的访问。如果没有任何规则匹配，则将拒绝访问。

要使用 AccessControl，请在控制器类的 behaviors() 方法中声明它。例如，以下声明将允许已认证的用户访问“create”和“update”操作，并拒绝所有其他用户访问这两个操作。

public function behaviors()
{
    return [
        'access' => [
            'class' => \yii\filters\AccessControl::class,
            'only' => ['create', 'update'],
            'rules' => [
                // deny all POST requests
                [
                    'allow' => false,
                    'verbs' => ['POST']
                ],
                // allow authenticated users
                [
                    'allow' => true,
                    'roles' => ['@'],
                ],
                // everything else is denied
            ],
        ],
    ];
}

公共属性

隐藏继承的属性

属性 类型 描述 定义于
$denyCallback callable|null 如果应拒绝当前用户访问，则将调用此回调。 yii\filters\AccessControl
$except array 此过滤器不应应用于的操作 ID 列表。 yii\base\ActionFilter
$only array 此过滤器应应用于的操作 ID 列表。 yii\base\ActionFilter
$owner yii\base\Component|null 此行为的所有者 yii\base\Behavior
$ruleConfig array 访问规则的默认配置。 yii\filters\AccessControl
$rules array 访问规则对象的列表或用于创建规则对象的配置数组。 yii\filters\AccessControl
$user yii\web\User|array|string|false 表示身份验证状态的用户对象或用户应用程序组件的 ID。 yii\filters\AccessControl

公共方法

隐藏继承的方法

方法 描述 定义于
__call() 调用不是类方法的命名方法。 yii\base\BaseObject
__construct() 构造函数。 yii\base\BaseObject
__get() 返回对象属性的值。 yii\base\BaseObject
__isset() 检查属性是否已设置，即定义且不为 null。 yii\base\BaseObject
__set() 设置对象属性的值。 yii\base\BaseObject
__unset() 将对象属性设置为 null。 yii\base\BaseObject
afterAction() 此方法在操作执行后立即调用。 yii\base\ActionFilter
afterFilter() yii\base\ActionFilter
attach() 将行为对象附加到组件。 yii\base\ActionFilter
beforeAction() 此方法在要执行操作之前立即调用（在所有可能的过滤器之后）。您可以覆盖此方法以对操作进行最后一刻的准备。 yii\filters\AccessControl
beforeFilter() yii\base\ActionFilter
canGetProperty() 返回一个值，指示是否可以读取属性。 yii\base\BaseObject
canSetProperty() 返回一个值，指示是否可以设置属性。 yii\base\BaseObject
className() 返回此类的完全限定名称。 yii\base\BaseObject
detach() 将行为对象从组件分离。 yii\base\ActionFilter
events() 声明 $owner 事件的事件处理程序。 yii\base\Behavior
hasMethod() 返回一个值，指示方法是否已定义。 yii\base\BaseObject
hasProperty() 返回一个值，指示属性是否已定义。 yii\base\BaseObject
init() 通过从配置实例化规则对象来初始化 $rules 数组。 yii\filters\AccessControl

受保护的方法

隐藏继承的方法

方法 描述 定义于
denyAccess() 拒绝用户的访问。 yii\filters\AccessControl
getActionId() 通过将 yii\base\Action::$uniqueId 转换为相对于模块的 ID 来返回操作 ID。 yii\base\ActionFilter
isActive() 返回一个值，指示过滤器对于给定操作是否处于活动状态。 yii\base\ActionFilter

属性详情

隐藏继承的属性

$denyCallback 公共属性

如果应拒绝当前用户访问，则将调用此回调。当没有规则匹配或 $allow 设置为 false 的规则匹配时，就会发生这种情况。如果未设置，则将调用 denyAccess()。

回调的签名应如下所示

function ($rule, $action)

其中 $rule 是拒绝用户的规则，$action 是当前的 action 对象。如果拒绝访问是因为没有规则匹配，则 $rule 可以为 null。

public callable|null $denyCallback = null
$ruleConfig 公共属性

访问规则的默认配置。通过 $rules 指定的单个规则配置在配置规则的同一属性时将优先。

public array $ruleConfig = [
    'class' => 'yii\filters\AccessRule',
]
$rules 公共属性

访问规则对象的列表或用于创建规则对象的配置数组。如果通过配置数组指定规则，则在用于创建规则对象之前，它将首先与 $ruleConfig 合并。

另请参见 $ruleConfig。

public array $rules = []
$user 公有属性

表示身份验证状态的用户对象或用户应用程序组件的 ID。从 2.0.2 版本开始，这也可以是用于创建对象的配置数组。从 2.0.12 版本开始，您可以将其设置为 false 以显式关闭过滤器对此组件的支持。

public yii\web\User|数组|字符串|布尔值 $user = 'user'

方法详情

隐藏继承的方法

__call() 公有方法

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

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

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

public 混合类型 __call ( $name, $params )
$name 字符串

方法名
$params array

方法参数
返回值 混合类型

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

调用未知方法时

 

                public function __call($name, $params)
{
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
__construct() 公有方法

定义于： 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();
}
__get() 公有方法

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

返回对象属性的值。

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

另请参阅 __set()。

public 混合类型 __get ( $name )
$name 字符串

属性名
返回值 混合类型

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

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

如果属性是只写属性

 

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter();
    } elseif (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\BaseObject::__isset()

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

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

请注意，如果未定义属性，则将返回 false。

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

public 布尔值 __isset ( $name )
$name 字符串

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

命名的属性是否已设置（非 null）。

 

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    return false;
}
__set() 公有方法

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

设置对象属性的值。

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

另请参阅 __get()。

public void __set ( $name, $value )
$name 字符串

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

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

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

如果属性是只读属性

 

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter($value);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    } else {
        throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
    }
}
__unset() 公有方法

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

将对象属性设置为 null。

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

请注意，如果未定义属性，则此方法将不执行任何操作。如果属性是只读属性，则会抛出异常。

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

public void __unset ( $name )
$name 字符串

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

如果属性是只读属性。

 

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name);
    }
}
afterAction() 公有方法

定义于： yii\base\ActionFilter::afterAction()

此方法在操作执行后立即调用。

您可以重写此方法来对操作进行一些后处理。

public 混合类型 afterAction ( $action, $result )
$action yii\base\Action

刚刚执行的操作。
$result 混合类型

操作执行结果
返回值 混合类型

已处理的操作结果。

 

                public function afterAction($action, $result)
{
    return $result;
}
afterFilter() 公有方法

定义于： yii\base\ActionFilter::afterFilter()

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

                public function afterFilter($event)
{
    $event->result = $this->afterAction($event->action, $event->result);
    $this->owner->off(Controller::EVENT_AFTER_ACTION, [$this, 'afterFilter']);
}
attach() 公有方法

定义于： yii\base\ActionFilter::attach()

将行为对象附加到组件。

默认实现将设置 $owner 属性并附加在 events() 中声明的事件处理程序。如果您重写此方法，请确保调用父实现。

public void attach ( $owner )
$owner yii\base\Component

要将此行为附加到的组件。

 

                public function attach($owner)
{
    $this->owner = $owner;
    $owner->on(Controller::EVENT_BEFORE_ACTION, [$this, 'beforeFilter']);
}
beforeAction() 公有方法

此方法在要执行操作之前立即调用（在所有可能的过滤器之后）。您可以覆盖此方法以对操作进行最后一刻的准备。

public 布尔型 beforeAction ( $action )
$action yii\base\Action

要执行的操作。
返回值 布尔值

操作是否应该继续执行。

 

                public function beforeAction($action)
{
    $user = $this->user;
    $request = Yii::$app->getRequest();
    /* @var $rule AccessRule */
    foreach ($this->rules as $rule) {
        if ($allow = $rule->allows($action, $user, $request)) {
            return true;
        } elseif ($allow === false) {
            if (isset($rule->denyCallback)) {
                call_user_func($rule->denyCallback, $rule, $action);
            } elseif ($this->denyCallback !== null) {
                call_user_func($this->denyCallback, $rule, $action);
            } else {
                $this->denyAccess($user);
            }
            return false;
        }
    }
    if ($this->denyCallback !== null) {
        call_user_func($this->denyCallback, null, $action);
    } else {
        $this->denyAccess($user);
    }
    return false;
}
beforeFilter() 公共方法

定义于： yii\base\ActionFilter::beforeFilter()

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

                public function beforeFilter($event)
{
    if (!$this->isActive($event->action)) {
        return;
    }
    $event->isValid = $this->beforeAction($event->action);
    if ($event->isValid) {
        // call afterFilter only if beforeFilter succeeds
        // beforeFilter and afterFilter should be properly nested
        $this->owner->on(Controller::EVENT_AFTER_ACTION, [$this, 'afterFilter'], null, false);
    } else {
        $event->handled = true;
    }
}
canGetProperty() 公共方法

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

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

如果属性可读，则

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

另请参阅 canSetProperty()。

public 布尔型 canGetProperty ( $name, $checkVars = true )
$name 字符串

属性名
$checkVars 布尔值

是否将成员变量视为属性
返回值 布尔值

属性是否可读

 

                public function canGetProperty($name, $checkVars = true)
{
    return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}
canSetProperty() 公共方法

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

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

如果属性可写，则

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

另请参阅 canGetProperty()。

public 布尔型 canSetProperty ( $name, $checkVars = true )
$name 字符串

属性名
$checkVars 布尔值

是否将成员变量视为属性
返回值 布尔值

属性是否可写

 

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

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

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

public static 字符串 className ( )
返回值 字符串

此类的完全限定名称。

 

                public static function className()
{
    return get_called_class();
}
denyAccess() 受保护方法

拒绝用户的访问。

默认实现将用户重定向到登录页面（如果他是访客）；如果用户已登录，则会抛出 403 HTTP 异常。

protected void denyAccess ( $user )
$user yii\web\User|false

当前用户或在 User 组件分离的情况下为布尔值 false
抛出异常 yii\web\ForbiddenHttpException

如果用户已登录或在 User 组件分离的情况下。

 

                protected function denyAccess($user)
{
    if ($user !== false && $user->getIsGuest()) {
        $user->loginRequired();
    } else {
        throw new ForbiddenHttpException(Yii::t('yii', 'You are not allowed to perform this action.'));
    }
}
detach() 公共方法

定义于： yii\base\ActionFilter::detach()

将行为对象从组件分离。

默认实现将取消设置 $owner 属性并分离在 events() 中声明的事件处理程序。如果您覆盖此方法，请确保调用父实现。

public void detach ( )

                public function detach()
{
    if ($this->owner) {
        $this->owner->off(Controller::EVENT_BEFORE_ACTION, [$this, 'beforeFilter']);
        $this->owner->off(Controller::EVENT_AFTER_ACTION, [$this, 'afterFilter']);
        $this->owner = null;
    }
}
events() 公共方法

定义于： yii\base\Behavior::events()

声明 $owner 事件的事件处理程序。

子类可以覆盖此方法来声明应将哪些 PHP 回调附加到 $owner 组件的事件。

当行为附加到所有者时，回调将附加到 $owner 的事件；当行为从组件分离时，它们将从事件中分离。

回调可以是以下任何一种

  • 此行为中的方法：'handleClick'，相当于 [$this, 'handleClick']
  • 对象方法：[$object, 'handleClick']
  • 静态方法：['Page', 'handleClick']
  • 匿名函数：function ($event) { ... }

以下是一个示例

[
    Model::EVENT_BEFORE_VALIDATE => 'myBeforeValidate',
    Model::EVENT_AFTER_VALIDATE => 'myAfterValidate',
]
public 数组 events ( )
返回值 array

事件（数组键）和相应的事件处理程序方法（数组值）。

 

                public function events()
{
    return [];
}
getActionId() 受保护方法（自版本 2.0.7 起可用）

定义于： yii\base\ActionFilter::getActionId()

通过将 yii\base\Action::$uniqueId 转换为相对于模块的 ID 来返回操作 ID。

protected 字符串 getActionId ( $action )
$action yii\base\Action 

                protected function getActionId($action)
{
    if ($this->owner instanceof Module) {
        $mid = $this->owner->getUniqueId();
        $id = $action->getUniqueId();
        if ($mid !== '' && strpos($id, $mid) === 0) {
            $id = substr($id, strlen($mid) + 1);
        }
    } else {
        $id = $action->id;
    }
    return $id;
}
hasMethod() 公共方法

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

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

默认实现是对 php 函数 method_exists() 的调用。当您实现 php 魔术方法 __call() 时，您可以覆盖此方法。

public 布尔型 hasMethod ( $name )
$name 字符串

方法名
返回值 布尔值

方法是否已定义

 

                public function hasMethod($name)
{
    return method_exists($this, $name);
}
hasProperty() 公共方法

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

返回一个值，指示属性是否已定义。

如果属性已定义，则

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

另请参阅

public 布尔型 hasProperty ( $name, $checkVars = true )
$name 字符串

属性名
$checkVars 布尔值

是否将成员变量视为属性
返回值 布尔值

属性是否已定义

 

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

通过从配置实例化规则对象来初始化 $rules 数组。

public void init ( )

                public function init()
{
    parent::init();
    if ($this->user !== false) {
        $this->user = Instance::ensure($this->user, User::className());
    }
    foreach ($this->rules as $i => $rule) {
        if (is_array($rule)) {
            $this->rules[$i] = Yii::createObject(array_merge($this->ruleConfig, $rule));
        }
    }
}
isActive() 受保护方法

定义于： yii\base\ActionFilter::isActive()

返回一个值，指示过滤器对于给定操作是否处于活动状态。

protected boolean isActive ( $action )
$action yii\base\Action

正在过滤的操作
返回值 布尔值

过滤器对于给定操作是否处于活动状态。

 

                protected function isActive($action)
{
    $id = $this->getActionId($action);
    if (empty($this->only)) {
        $onlyMatch = true;
    } else {
        $onlyMatch = false;
        foreach ($this->only as $pattern) {
            if (StringHelper::matchWildcard($pattern, $id)) {
                $onlyMatch = true;
                break;
            }
        }
    }
    $exceptMatch = false;
    foreach ($this->except as $pattern) {
        if (StringHelper::matchWildcard($pattern, $id)) {
            $exceptMatch = true;
            break;
        }
    }
    return !$exceptMatch && $onlyMatch;
}