Class mdm\admin\components\RouteRule

Inheritancemdm\admin\components\RouteRule » yii\rbac\Rule » yii\base\Object
Available since version1.0

RouteRule Rule for check route with extra params.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$createdAt integer UNIX timestamp representing the rule creation time yii\rbac\Rule
$name string Name of the rule yii\rbac\Rule
$updatedAt integer UNIX timestamp representing the rule updating time yii\rbac\Rule

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. yii\base\Object
__construct() Constructor. yii\base\Object
__get() Returns the value of an object property. yii\base\Object
__isset() Checks if the named property is set (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
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
execute() Executes the rule. mdm\admin\components\RouteRule
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

Constants

Hide inherited constants

ConstantValueDescriptionDefined By
RULE_NAME 'route_rule' mdm\admin\components\RouteRule

Method Details

execute() public method

Executes the rule.

boolean execute$user$item$params )
$user string|integer

The user ID. This should be either an integer or a string representing the unique identifier of a user. See yii\web\User::$id.

$item yii\rbac\Item

The role or permission that this rule is associated with

$params array

Parameters passed to \mdm\admin\components\ManagerInterface::checkAccess().

return boolean

A value indicating whether the rule permits the auth item it is associated with.