yii\filters\AccessControl 访问权限控制

向右看齐 2021-10-26 16:52 326阅读 0赞

# Class yii\\filters\\AccessControl #

所有类 | 属性 | 方法

<table> 
 <tbody> 
 <tr> 
 <th>继承</th> 
 <td><a rel="nofollow">yii\filters\AccessControl</a> » <a rel="nofollow">yii\base\ActionFilter</a> » <a rel="nofollow">yii\base\Behavior</a> » <a rel="nofollow">yii\base\BaseObject</a></td> 
 </tr> 
 <tr> 
 <th>实现</th> 
 <td><a rel="nofollow">yii\base\Configurable</a></td> 
 </tr> 
 <tr> 
 <th>可用版本自</th> 
 <td>2.0</td> 
 </tr> 
 <tr> 
 <th>源码</th> 
 <td><a href="https://github.com/yiichina/yii2/blob/api/framework/filters/AccessControl.php" rel="nofollow">https://github.com/yiichina/yii2/blob/api/framework/filters/AccessControl.php</a></td> 
 </tr> 
 </tbody> 
</table>

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

AccessControl 是一个操作筛选器。它将检查其 $rules 查找 匹配当前上下文变量（例如用户IIp 地址、用户角色）的第一条规则。 匹配规则将指定是允许还是拒绝访问所请求的控制器 操作。如果没有匹配的规则，访问将被拒绝。

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

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

## 公共属性 ##

隐藏继承的属性

<table> 
 <tbody> 
 <tr> 
 <th>属性</th> 
 <th>类型</th> 
 <th>描述</th> 
 <th>被定义在</th> 
 </tr> 
 <tr> 
 <td><a rel="nofollow">$denyCallback</a></td> 
 <td><a href="http://www.php.net/language.types.callable" rel="nofollow">callable</a></td> 
 <td> 在拒绝当前用户访问时将调用的回调。 如果没有匹配的规则或者是符合以下条件的规则，则会出现这种情况 <a rel="nofollow">$allow</a> 设置成 <code>false</code> 匹配。 如果未设置，<a rel="nofollow">denyAccess()</a> 将会被调用。 回调的签名应如下所示: <code>`</code>php function ($rule, $action) <code>`</code> 其中 <code>$rule</code> 是拒绝用户的规则， <code>$action</code> 是当前 <a rel="nofollow">action</a> 对象。 如果访问被拒绝则 <code>$rule</code> 可以为 <code>null</code> 因为所有规则都不匹配。 </td> 
 <td><a rel="nofollow">yii\filters\AccessControl</a></td> 
 </tr> 
 <tr> 
 <td><a rel="nofollow">$except</a></td> 
 <td><a href="http://www.php.net/language.types.array" rel="nofollow">array</a></td> 
 <td> 列出所有不需要启用过滤规则的action ID 如：['index1','index2'] 表示：这两个方法不进行规则验证，所有用户，所有状态都能访问 </td> 
 <td><a rel="nofollow">yii\base\ActionFilter</a></td> 
 </tr> 
 <tr> 
 <td><a rel="nofollow">$only</a></td> 
 <td><a href="http://www.php.net/language.types.array" rel="nofollow">array</a></td> 
 <td> 列出所有需要启用过滤规则的action ID。 如：['index1','index2','index3'] 表示： 如果用户访问index方法，那么不进行身份验证，所有用户，所有状态都能访问 </td> 
 <td><a rel="nofollow">yii\base\ActionFilter</a></td> 
 </tr> 
 <tr> 
 <td><a rel="nofollow">$owner</a></td> 
 <td><a rel="nofollow">yii\base\Component</a>|<a href="http://www.php.net/language.types.null" rel="nofollow">null</a></td> 
 <td>The owner of this behavior</td> 
 <td><a rel="nofollow">yii\base\Behavior</a></td> 
 </tr> 
 <tr> 
 <td><a rel="nofollow">$ruleConfig</a></td> 
 <td><a href="http://www.php.net/language.types.array" rel="nofollow">array</a></td> 
 <td>访问规则的默认配置。单个规则配置 在配置规则的相同属性时 via <a rel="nofollow">$rules</a> 将优先。</td> 
 <td><a rel="nofollow">yii\filters\AccessControl</a></td> 
 </tr> 
 <tr> 
 <td><a rel="nofollow">$rules</a></td> 
 <td><a href="http://www.php.net/language.types.array" rel="nofollow">array</a></td> 
 <td> 访问规则对象的列表或用于创建规则对象的配置数组。 如果规则是通过配置数组指定的， 它将首先与 <a rel="nofollow">$ruleConfig</a> 合并 在用于创建规则对象之前。 </td> 
 <td><a rel="nofollow">yii\filters\AccessControl</a></td> 
 </tr> 
 <tr> 
 <td><a rel="nofollow">$user</a></td> 
 <td><a rel="nofollow">yii\web\User</a>|<a href="http://www.php.net/language.types.array" rel="nofollow">array</a>|<a href="http://www.php.net/language.types.string" rel="nofollow">string</a>|<a href="http://www.php.net/language.types.boolean" rel="nofollow">false</a></td> 
 <td>表示用户应用程序组件的身份验证状态或ID的用户对象。 从版本 2.</td> 
 <td><a rel="nofollow">yii\filters\AccessControl</a></td> 
 </tr> 
 </tbody> 
</table>

## 公共方法 ##

隐藏继承的方法

<table> 
 <tbody> 
 <tr> 
 <th>方法</th> 
 <th>描述</th> 
 <th>被定义在</th> 
 </tr> 
 <tr> 
 <td><a rel="nofollow">__call()</a></td> 
 <td>Calls the named method which is not a class method.</td> 
 <td><a rel="nofollow">yii\base\BaseObject</a></td> 
 </tr> 
 <tr> 
 <td><a rel="nofollow">__construct()</a></td> 
 <td>Constructor.</td> 
 <td><a rel="nofollow">yii\base\BaseObject</a></td> 
 </tr> 
 <tr> 
 <td><a rel="nofollow">__get()</a></td> 
 <td>Returns the value of an object property.</td> 
 <td><a rel="nofollow">yii\base\BaseObject</a></td> 
 </tr> 
 <tr> 
 <td><a rel="nofollow">__isset()</a></td> 
 <td>Checks if a property is set, i.e. defined and not null.</td> 
 <td><a rel="nofollow">yii\base\BaseObject</a></td> 
 </tr> 
 <tr> 
 <td><a rel="nofollow">__set()</a></td> 
 <td>Sets value of an object property.</td> 
 <td><a rel="nofollow">yii\base\BaseObject</a></td> 
 </tr> 
 <tr> 
 <td><a rel="nofollow">__unset()</a></td> 
 <td>Sets an object property to null.</td> 
 <td><a rel="nofollow">yii\base\BaseObject</a></td> 
 </tr> 
 <tr> 
 <td><a rel="nofollow">afterAction()</a></td> 
 <td>执行动作后立即调用此方法。 您可以覆盖此方法以对操作执行一些后处理。</td> 
 <td><a rel="nofollow">yii\base\ActionFilter</a></td> 
 </tr> 
 <tr> 
 <td><a rel="nofollow">afterFilter()</a></td> 
 <td>&nbsp;</td> 
 <td><a rel="nofollow">yii\base\ActionFilter</a></td> 
 </tr> 
 <tr> 
 <td><a rel="nofollow">attach()</a></td> 
 <td>Attaches the behavior object to the component.</td> 
 <td><a rel="nofollow">yii\base\Behavior</a></td> 
 </tr> 
 <tr> 
 <td><a rel="nofollow">beforeAction()</a></td> 
 <td>此方法是在执行操作之前（在所有可能的筛选器之后。）调用 您可以重写此方法以便为操作做最后一刻的准备。</td> 
 <td><a rel="nofollow">yii\filters\AccessControl</a></td> 
 </tr> 
 <tr> 
 <td><a rel="nofollow">beforeFilter()</a></td> 
 <td>&nbsp;</td> 
 <td><a rel="nofollow">yii\base\ActionFilter</a></td> 
 </tr> 
 <tr> 
 <td><a rel="nofollow">canGetProperty()</a></td> 
 <td>Returns a value indicating whether a property can be read.</td> 
 <td><a rel="nofollow">yii\base\BaseObject</a></td> 
 </tr> 
 <tr> 
 <td><a rel="nofollow">canSetProperty()</a></td> 
 <td>Returns a value indicating whether a property can be set.</td> 
 <td><a rel="nofollow">yii\base\BaseObject</a></td> 
 </tr> 
 <tr> 
 <td><a rel="nofollow">className()</a></td> 
 <td>Returns the fully qualified name of this class.</td> 
 <td><a rel="nofollow">yii\base\BaseObject</a></td> 
 </tr> 
 <tr> 
 <td><a rel="nofollow">detach()</a></td> 
 <td>Detaches the behavior object from the component.</td> 
 <td><a rel="nofollow">yii\base\Behavior</a></td> 
 </tr> 
 <tr> 
 <td><a rel="nofollow">events()</a></td> 
 <td>Declares event handlers for the <a rel="nofollow">$owner</a>'s events.</td> 
 <td><a rel="nofollow">yii\base\Behavior</a></td> 
 </tr> 
 <tr> 
 <td><a rel="nofollow">hasMethod()</a></td> 
 <td>Returns a value indicating whether a method is defined.</td> 
 <td><a rel="nofollow">yii\base\BaseObject</a></td> 
 </tr> 
 <tr> 
 <td><a rel="nofollow">hasProperty()</a></td> 
 <td>Returns a value indicating whether a property is defined.</td> 
 <td><a rel="nofollow">yii\base\BaseObject</a></td> 
 </tr> 
 <tr> 
 <td><a rel="nofollow">init()</a></td> 
 <td>通过从配置实例化规则对象来初始化 <a rel="nofollow">$rules</a> 数组。</td> 
 <td><a rel="nofollow">yii\filters\AccessControl</a></td> 
 </tr> 
 </tbody> 
</table>

## 受保护的方法 ##

隐藏继承的方法

## 属性详情 ##

$denyCallback  公共 属性

在拒绝当前用户访问时将调用的回调。 如果没有匹配的规则或者是符合以下条件的规则，则会出现这种情况 $allow 设置成 `false` 匹配。 如果未设置，denyAccess() 将会被调用。

回调的签名应如下所示:

function($rule, $action)

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

public [callable][] $denyCallback = null

$ruleConfig  公共 属性

访问规则的默认配置。单个规则配置 在配置规则的相同属性时 via $rules 将优先。

public [array][] $ruleConfig = \['class' => 'yii\\filters\\AccessRule'\]

$rules  公共 属性

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

参见 \[\[规则配置\]\].

public [array][] $rules = \[\]

$user  公共 属性

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

public yii\\web\\User|[array][]|[string][]|[false][] $user = 'user'

## 方法详情 ##

beforeAction()  公共 方法

**此方法是在执行操作之前（在所有可能的筛选器之后。）调用 您可以重写此方法以便为操作做最后一刻的准备。**

<table> 
 <tbody> 
 <tr> 
 <td colspan="3">public <a href="http://www.php.net/language.types.boolean" rel="nofollow">boolean</a> <a rel="nofollow">beforeAction</a>($action)</td> 
 </tr> 
 <tr> 
 <td>$action</td> 
 <td><a rel="nofollow">yii\base\Action</a></td> 
 <td> 要执行的操作。 </td> 
 </tr> 
 <tr> 
 <th>return</th> 
 <td><a href="http://www.php.net/language.types.boolean" rel="nofollow">boolean</a></td> 
 <td> 是否应继续执行该操作。 </td> 
 </tr> 
 </tbody> 
</table>

denyAccess()  受保护 方法

**拒绝用户访问。 如果用户是访客默认实现会将用户重定向到登录页面； 如果用户已登录，则将引发 403 HTTP 异常。**

<table> 
 <tbody> 
 <tr> 
 <td colspan="3">protected void <a rel="nofollow">denyAccess</a>($user)</td> 
 </tr> 
 <tr> 
 <td>$user</td> 
 <td><a rel="nofollow">yii\web\User</a>|<a href="http://www.php.net/language.types.boolean" rel="nofollow">false</a></td> 
 <td> 在分离用户组件的情况下当前用户或布尔值 <code>false</code> </td> 
 </tr> 
 <tr> 
 <th>throws</th> 
 <td><a rel="nofollow">yii\web\ForbiddenHttpException</a></td> 
 <td> 如果用户已经登录或者已分离用户组件。 </td> 
 </tr> 
 </tbody> 
</table>

init()  公共 方法

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

<table> 
 <tbody> 
 <tr> 
 <td colspan="3">public void <a rel="nofollow">init</a>()</td> 
 </tr> 
 </tbody> 
</table>

转载于:https://www.cnblogs.com/fpcing/p/11377089.html

[callable]: http://www.php.net/language.types.callable
[array]: http://www.php.net/language.types.array
[string]: http://www.php.net/language.types.string
[false]: http://www.php.net/language.types.boolean