Inheritance | yii\filters\AccessRule » yii\base\Component » yii\base\Object |
---|---|
Implements | yii\base\Configurable |
Available since version | 2.0 |
Source Code | https://github.com/yiisoft/yii2/blob/master/framework/filters/AccessRule.php |
This class represents an access rule defined by the yii\filters\AccessControl action filter
Property | Type | Description | Defined By |
---|---|---|---|
$actions | array | List of action IDs that this rule applies to. | yii\filters\AccessRule |
$allow | boolean | Whether this is an 'allow' rule or 'deny' rule. | yii\filters\AccessRule |
$behaviors | yii\base\Behavior[] | List of behaviors attached to this component | yii\base\Component |
$controllers | array | List of the controller IDs that this rule applies to. | yii\filters\AccessRule |
$denyCallback | callable | A callback that will be called if this rule determines the access to the current action should be denied. | yii\filters\AccessRule |
$ips | array | List of user IP addresses that this rule applies to. | yii\filters\AccessRule |
$matchCallback | callable | A callback that will be called to determine if the rule should be applied. | yii\filters\AccessRule |
$roles | array | List of roles that this rule applies to. | yii\filters\AccessRule |
$verbs | array | List of request methods (e.g. GET , POST ) that this rule applies to. | yii\filters\AccessRule |
Method | Description | Defined By |
---|---|---|
__call() | Calls the named method which is not a class method. | yii\base\Object |
__clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component |
__construct() | Constructor. | yii\base\Object |
__get() | Returns the value of an object property. | yii\base\Object |
__isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Object |
__set() | Sets value of an object property. | yii\base\Object |
__unset() | Sets an object property to null. | yii\base\Object |
allows() | Checks whether the Web user is allowed to perform the specified action. | yii\filters\AccessRule |
attachBehavior() | Attaches a behavior to this component. | yii\base\Component |
attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component |
behaviors() | Returns a list of behaviors that this component should behave as. | yii\base\Component |
canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Object |
canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Object |
className() | Returns the fully qualified name of this class. | yii\base\Object |
detachBehavior() | Detaches a behavior from the component. | yii\base\Component |
detachBehaviors() | Detaches all behaviors from the component. | yii\base\Component |
ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component |
getBehavior() | Returns the named behavior object. | yii\base\Component |
getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component |
hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component |
hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Object |
hasProperty() | Returns a value indicating whether a property is defined. | yii\base\Object |
init() | Initializes the object. | yii\base\Object |
off() | Detaches an existing event handler from this component. | yii\base\Component |
on() | Attaches an event handler to an event. | yii\base\Component |
trigger() | Triggers an event. | yii\base\Component |
List of action IDs that this rule applies to. The comparison is case-sensitive. If not set or empty, it means this rule applies to all actions.
public array $actions = null
Whether this is an 'allow' rule or 'deny' rule.
public boolean $allow = null
List of the controller IDs that this rule applies to.
The comparison uses yii\base\Controller::$uniqueId, so each controller ID is prefixed with the module ID (if any). For a product
controller in the application, you would specify this property like ['product']
and if that controller is located in a shop
module, this would be ['shop/product']
.
The comparison is case-sensitive.
If not set or empty, it means this rule applies to all controllers.
public array $controllers = null
A callback that will be called if this rule determines the access to the current action should be denied. If not set, the behavior will be determined by yii\filters\AccessControl.
The signature of the callback should be as follows:
function ($rule, $action)
where $rule
is this rule, and $action
is the current action object.
public callable $denyCallback = null
List of user IP addresses that this rule applies to. An IP address can contain the wildcard *
at the end so that it matches IP addresses with the same prefix. For example, '192.168.*' matches all IP addresses in the segment '192.168.'. If not set or empty, it means this rule applies to all IP addresses.
See also yii\web\Request::$userIP.
public array $ips = null
A callback that will be called to determine if the rule should be applied. The signature of the callback should be as follows:
function ($rule, $action)
where $rule
is this rule, and $action
is the current action object. The callback should return a boolean value indicating whether this rule should be applied.
public callable $matchCallback = null
List of roles that this rule applies to. Two special roles are recognized, and they are checked via yii\web\User::$isGuest:
?
: matches a guest user (not authenticated yet)@
: matches an authenticated userIf you are using RBAC (Role-Based Access Control), you may also specify role or permission names. In this case, yii\web\User::can() will be called to check access.
If this property is not set or empty, it means this rule applies to all roles.
public array $roles = null
List of request methods (e.g. GET
, POST
) that this rule applies to. If not set or empty, it means this rule applies to all request methods.
See also yii\web\Request::$method.
public array $verbs = null
Checks whether the Web user is allowed to perform the specified action.
public boolean|null allows ( $action, $user, $request ) | ||
---|---|---|
$action | yii\base\Action |
The action to be performed |
$user | yii\web\User |
The user object |
$request | yii\web\Request | |
return | boolean|null |
True if the user is allowed, false if the user is denied, null if the rule does not apply to the user |
protected boolean matchAction ( $action ) | ||
---|---|---|
$action | yii\base\Action |
The action |
return | boolean |
Whether the rule applies to the action |
protected boolean matchController ( $controller ) | ||
---|---|---|
$controller | yii\base\Controller |
The controller |
return | boolean |
Whether the rule applies to the controller |
protected boolean matchCustom ( $action ) | ||
---|---|---|
$action | yii\base\Action |
The action to be performed |
return | boolean |
Whether the rule should be applied |
protected boolean matchIP ( $ip ) | ||
---|---|---|
$ip | string |
The IP address |
return | boolean |
Whether the rule applies to the IP address |
protected boolean matchRole ( $user ) | ||
---|---|---|
$user | yii\web\User |
The user object |
return | boolean |
Whether the rule applies to the role |
protected boolean matchVerb ( $verb ) | ||
---|---|---|
$verb | string |
The request method. |
return | boolean |
Whether the rule applies to the request |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-filters-accessrule.html