public string $assignmentFile = '@app/rbac/assignments.php'

protected array $assignments = []

protected array $children = []

public string $itemFile = '@app/rbac/items.php'

protected yii\rbac\Item[] $items = []

public string $ruleFile = '@app/rbac/rules.php'

public yii\rbac\Rule[] getRules ( )

addChild() public method

Adds an item as a child of another item.

public boolean addChild ( $parent, $child )
$parent	yii\rbac\Item
$child	yii\rbac\Item
return	boolean	Whether the child successfully added
throws	yii\base\Exception	if the parent-child relationship already exists or if a loop has been detected.

addItem() protected method

Adds an auth item to the RBAC system.

protected boolean addItem ( $item )
$item	yii\rbac\Item	The item to add
return	boolean	Whether the auth item is successfully added to the system
throws	Exception	if data validation or saving fails (such as the name of the role or permission is not unique)

addRule() protected method

Adds a rule to the RBAC system.

protected boolean addRule ( $rule )
$rule	yii\rbac\Rule	The rule to add
return	boolean	Whether the rule is successfully added to the system
throws	Exception	if data validation or saving fails (such as the name of the rule is not unique)

assign() public method

Assigns a role to a user.

public yii\rbac\Assignment assign ( $role, $userId )
$role	yii\rbac\Role
$userId	string|integer	The user ID (see yii\web\User::$id)
return	yii\rbac\Assignment	The role assignment information.
throws	Exception	if the role has already been assigned to the user

canAddChild() public method (available since version 2.0.8)

Checks the possibility of adding a child to parent

public boolean canAddChild ( $parent, $child )
$parent	yii\rbac\Item	The parent item
$child	yii\rbac\Item	The child item to be added to the hierarchy
return	boolean	Possibility of adding

checkAccess() public method

public void checkAccess ( $userId, $permissionName, $params = [] )
$userId
$permissionName
$params

checkAccessRecursive() protected method

Performs access check for the specified user.

This method is internally called by checkAccess().

protected boolean checkAccessRecursive ( $user, $itemName, $params, $assignments )
$user	string|integer	The user ID. This should can be either an integer or a string representing the unique identifier of a user. See yii\web\User::$id.
$itemName	string	The name of the operation that need access check
$params	array	Name-value pairs that would be passed to rules associated with the tasks and roles assigned to the user. A param with name 'user' is added to this array, which holds the value of $userId.
$assignments	yii\rbac\Assignment[]	The assignments to the specified user
return	boolean	Whether the operations can be performed by the user.

detectLoop() protected method

Checks whether there is a loop in the authorization item hierarchy.

protected boolean detectLoop ( $parent, $child )
$parent	yii\rbac\Item	Parent item
$child	yii\rbac\Item	The child item that is to be added to the hierarchy
return	boolean	Whether a loop exists

getAssignment() public method

Returns the assignment information regarding a role and a user.

public null|yii\rbac\Assignment getAssignment ( $roleName, $userId )
$roleName	string	The role name
$userId	string|integer	The user ID (see yii\web\User::$id)
return	null|yii\rbac\Assignment	The assignment information. Null is returned if the role is not assigned to the user.

getAssignments() public method

Returns all role assignment information for the specified user.

public yii\rbac\Assignment[] getAssignments ( $userId )
$userId	string|integer	The user ID (see yii\web\User::$id)
return	yii\rbac\Assignment[]	The assignments indexed by role names. An empty array will be returned if there is no role assigned to the user.

getChildRoles() public method

Returns child roles of the role specified. Depth isn't limited.

public yii\rbac\Role[] getChildRoles ( $roleName )
$roleName	string	Name of the role to file child roles for
return	yii\rbac\Role[]	Child roles. The array is indexed by the role names. First element is an instance of the parent Role itself.
throws	yii\base\InvalidParamException	if Role was not found that are getting by $roleName

getChildren() public method

Returns the child permissions and/or roles.

public yii\rbac\Item[] getChildren ( $name )
$name	string	The parent name
return	yii\rbac\Item[]	The child permissions and/or roles

getChildrenRecursive() protected method

Recursively finds all children and grand children of the specified item.

protected void getChildrenRecursive ( $name, &$result )
$name	string	The name of the item whose children are to be looked for.
$result	array	The children and grand children (in array keys)

getDirectPermissionsByUser() protected method (available since version 2.0.7)

Returns all permissions that are directly assigned to user.

protected yii\rbac\Permission[] getDirectPermissionsByUser ( $userId )
$userId	string|integer	The user ID (see yii\web\User::$id)
return	yii\rbac\Permission[]	All direct permissions that the user has. The array is indexed by the permission names.

getInheritedPermissionsByUser() protected method (available since version 2.0.7)

Returns all permissions that the user inherits from the roles assigned to him.

protected yii\rbac\Permission[] getInheritedPermissionsByUser ( $userId )
$userId	string|integer	The user ID (see yii\web\User::$id)
return	yii\rbac\Permission[]	All inherited permissions that the user has. The array is indexed by the permission names.

getItem() public method

Returns the named auth item.

public yii\rbac\Item getItem ( $name )
$name	string	The auth item name.
return	yii\rbac\Item	The auth item corresponding to the specified name. Null is returned if no such item.

getItems() public method

Returns the items of the specified type.

public yii\rbac\Item[] getItems ( $type )
$type	integer	The auth item type (either yii\rbac\Item::TYPE_ROLE or yii\rbac\Item::TYPE_PERMISSION
return	yii\rbac\Item[]	The auth items of the specified type.

getPermissionsByRole() public method

Returns all permissions that the specified role represents.

public yii\rbac\Permission[] getPermissionsByRole ( $roleName )
$roleName	string	The role name
return	yii\rbac\Permission[]	All permissions that the role represents. The array is indexed by the permission names.

getPermissionsByUser() public method

Returns all permissions that the user has.

public yii\rbac\Permission[] getPermissionsByUser ( $userId )
$userId	string|integer	The user ID (see yii\web\User::$id)
return	yii\rbac\Permission[]	All permissions that the user has. The array is indexed by the permission names.

getRolesByUser() public method

Returns the roles that are assigned to the user via assign().

Note that child roles that are not assigned directly to the user will not be returned.

public yii\rbac\Role[] getRolesByUser ( $userId )
$userId	string|integer	The user ID (see yii\web\User::$id)
return	yii\rbac\Role[]	All roles directly assigned to the user. The array is indexed by the role names.

getRule() public method

Returns the rule of the specified name.

public null|yii\rbac\Rule getRule ( $name )
$name	string	The rule name
return	null|yii\rbac\Rule	The rule object, or null if the specified name does not correspond to a rule.

getRules() public method

Returns all rules available in the system.

public yii\rbac\Rule[] getRules ( )
return	yii\rbac\Rule[]	The rules indexed by the rule names

getUserIdsByRole() public method (available since version 2.0.7)

Returns all user IDs assigned to the role specified.

public array getUserIdsByRole ( $roleName )
$roleName	string
return	array	Array of user ID strings

hasChild() public method

Returns a value indicating whether the child already exists for the parent.

public boolean hasChild ( $parent, $child )
$parent	yii\rbac\Item
$child	yii\rbac\Item
return	boolean	Whether $child is already a child of $parent

init() public method

Initializes the application component.

This method overrides parent implementation by loading the authorization data from PHP script.

public void init ( )

invalidateScriptCache() protected method (available since version 2.0.9)

Invalidates precompiled script cache (such as OPCache or APC) for the given file.

protected void invalidateScriptCache ( $file )
$file	string	The file path.

load() protected method

Loads authorization data from persistent storage.

protected void load ( )

loadFromFile() protected method

Loads the authorization data from a PHP script file.

See also saveToFile().

protected array loadFromFile ( $file )
$file	string	The file path.
return	array	The authorization data

removeAll() public method

Removes all authorization data, including roles, permissions, rules, and assignments.

public void removeAll ( )

removeAllAssignments() public method

Removes all role assignments.

public void removeAllAssignments ( )

removeAllItems() protected method

Removes all auth items of the specified type.

protected void removeAllItems ( $type )
$type	integer	The auth item type (either Item::TYPE_PERMISSION or Item::TYPE_ROLE)

removeAllPermissions() public method

Removes all permissions.

All parent child relations will be adjusted accordingly.

public void removeAllPermissions ( )

removeAllRoles() public method

Removes all roles.

All parent child relations will be adjusted accordingly.

public void removeAllRoles ( )

removeAllRules() public method

Removes all rules.

All roles and permissions which have rules will be adjusted accordingly.

public void removeAllRules ( )

removeChild() public method

Removes a child from its parent.

Note, the child item is not deleted. Only the parent-child relationship is removed.

public boolean removeChild ( $parent, $child )
$parent	yii\rbac\Item
$child	yii\rbac\Item
return	boolean	Whether the removal is successful

removeChildren() public method

Removed all children form their parent.

Note, the children items are not deleted. Only the parent-child relationships are removed.

public boolean removeChildren ( $parent )
$parent	yii\rbac\Item
return	boolean	Whether the removal is successful

removeItem() public method

Removes an auth item from the RBAC system.

public boolean removeItem ( $item )
$item	yii\rbac\Item	The item to remove
return	boolean	Whether the role or permission is successfully removed
throws	Exception	if data validation or saving fails (such as the name of the role or permission is not unique)

removeRule() protected method

Removes a rule from the RBAC system.

protected boolean removeRule ( $rule )
$rule	yii\rbac\Rule	The rule to remove
return	boolean	Whether the rule is successfully removed
throws	Exception	if data validation or saving fails (such as the name of the rule is not unique)

revoke() public method

Revokes a role from a user.

public boolean revoke ( $role, $userId )
$role	yii\rbac\Role
$userId	string|integer	The user ID (see yii\web\User::$id)
return	boolean	Whether the revoking is successful

revokeAll() public method

Revokes all roles from a user.

public boolean revokeAll ( $userId )
$userId	mixed	The user ID (see yii\web\User::$id)
return	boolean	Whether the revoking is successful

save() protected method

Saves authorization data into persistent storage.

protected void save ( )

saveAssignments() protected method

Saves assignments data into persistent storage.

protected void saveAssignments ( )

saveItems() protected method

Saves items data into persistent storage.

protected void saveItems ( )

saveRules() protected method

Saves rules data into persistent storage.

protected void saveRules ( )

saveToFile() protected method

Saves the authorization data to a PHP script file.

See also loadFromFile().

protected void saveToFile ( $data, $file )
$data	array	The authorization data
$file	string	The file path.

updateItem() protected method

Updates an auth item in the RBAC system.

protected boolean updateItem ( $name, $item )
$name	string	The name of the item being updated
$item	yii\rbac\Item	The updated item
return	boolean	Whether the auth item is successfully updated
throws	Exception	if data validation or saving fails (such as the name of the role or permission is not unique)

updateRule() public method

Updates a rule to the RBAC system.

public boolean updateRule ( $name, $rule )
$name	string	The name of the rule being updated
$rule	yii\rbac\Rule	The updated rule
return	boolean	Whether the rule is successfully updated
throws	Exception	if data validation or saving fails (such as the name of the rule is not unique)