# Interface yii\rbac\ManagerInterface

Extends | yii\rbac\CheckAccessInterface
Implemented by | yii\mongodb\rbac\MongoDbManager, yii\rbac\BaseManager, yii\rbac\DbManager, yii\rbac\PhpManager
Available since version | 2.0
Source Code | https://github.com/yiisoft/yii2/blob/master/framework/rbac/ManagerInterface.php

For more details and usage information on ManagerInterface, see the guide article on security authorization.

## Public Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
add() | Adds a role, permission or rule to the RBAC system. | yii\rbac\ManagerInterface
addChild() | Adds an item as a child of another item. | yii\rbac\ManagerInterface
assign() | Assigns a role to a user. | yii\rbac\ManagerInterface
canAddChild() | Checks the possibility of adding a child to parent. | yii\rbac\ManagerInterface
checkAccess() | Checks if the user has the specified permission. | yii\rbac\CheckAccessInterface
createPermission() | Creates a new Permission object. | yii\rbac\ManagerInterface
createRole() | Creates a new Role object. | yii\rbac\ManagerInterface
getAssignment() | Returns the assignment information regarding a role and a user. | yii\rbac\ManagerInterface
getAssignments() | Returns all role assignment information for the specified user. | yii\rbac\ManagerInterface
getChildRoles() | Returns child roles of the role specified. Depth isn't limited. | yii\rbac\ManagerInterface
getChildren() | Returns the child permissions and/or roles. | yii\rbac\ManagerInterface
getPermission() | Returns the named permission. | yii\rbac\ManagerInterface
getPermissions() | Returns all permissions in the system. | yii\rbac\ManagerInterface
getPermissionsByRole() | Returns all permissions that the specified role represents. | yii\rbac\ManagerInterface
getPermissionsByUser() | Returns all permissions that the user has. | yii\rbac\ManagerInterface
getRole() | Returns the named role. | yii\rbac\ManagerInterface
getRoles() | Returns all roles in the system. | yii\rbac\ManagerInterface
getRolesByUser() | Returns the roles that are assigned to the user via assign(). | yii\rbac\ManagerInterface
getRule() | Returns the rule of the specified name. | yii\rbac\ManagerInterface
getRules() | Returns all rules available in the system. | yii\rbac\ManagerInterface
getUserIdsByRole() | Returns all user IDs assigned to the role specified. | yii\rbac\ManagerInterface
hasChild() | Returns a value indicating whether the child already exists for the parent. | yii\rbac\ManagerInterface
remove() | Removes a role, permission or rule from the RBAC system. | yii\rbac\ManagerInterface
removeAll() | Removes all authorization data, including roles, permissions, rules, and assignments. | yii\rbac\ManagerInterface
removeAllAssignments() | Removes all role assignments. | yii\rbac\ManagerInterface
removeAllPermissions() | Removes all permissions. | yii\rbac\ManagerInterface
removeAllRoles() | Removes all roles. | yii\rbac\ManagerInterface
removeAllRules() | Removes all rules. | yii\rbac\ManagerInterface
removeChild() | Removes a child from its parent. | yii\rbac\ManagerInterface
removeChildren() | Removed all children form their parent. | yii\rbac\ManagerInterface
revoke() | Revokes a role from a user. | yii\rbac\ManagerInterface
revokeAll() | Revokes all roles from a user. | yii\rbac\ManagerInterface
update() | Updates the specified role, permission or rule in the system. | yii\rbac\ManagerInterface

## Method Details

Hide inherited methods

add() public abstract method

Adds a role, permission or rule to the RBAC system.

public abstract boolean add ( $object )
$object | yii\rbac\Role|yii\rbac\Permission|yii\rbac\Rule |
return | boolean | Whether the role, permission or rule 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)

Source code

                    public function add($object);

addChild() public abstract method

Adds an item as a child of another item.

public abstract 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.

Source code

                    public function addChild($parent, $child);

assign() public abstract method

Assigns a role to a user.

public abstract yii\rbac\Assignment assign ( $role, $userId )
$role | yii\rbac\Role|yii\rbac\Permission |
$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

Source code

                    public function assign($role, $userId);

canAddChild() public abstract method (available since version 2.0.8)

Checks the possibility of adding a child to parent.

public abstract 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

Source code

                    public function canAddChild($parent, $child);

checkAccess() public abstract method

Defined in: yii\rbac\CheckAccessInterface::checkAccess()

Checks if the user has the specified permission.

public abstract boolean checkAccess ( $userId, $permissionName, $params = [] )
$userId | 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.
$permissionName | string | The name of the permission to be checked against
$params | array | Name-value pairs that will be passed to the rules associated with the roles and permissions assigned to the user.
return | boolean | Whether the user has the specified permission.
throws | yii\base\InvalidParamException | if $permissionName does not refer to an existing permission

Source code

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

createPermission() public abstract method

Creates a new Permission object.

Note that the newly created permission is not added to the RBAC system yet. You must fill in the needed data and call add() to add it to the system.

public abstract yii\rbac\Permission createPermission ( $name )
$name | string | The permission name
return | yii\rbac\Permission | The new Permission object

Source code

                    public function createPermission($name);

createRole() public abstract method

Creates a new Role object.

Note that the newly created role is not added to the RBAC system yet. You must fill in the needed data and call add() to add it to the system.

public abstract yii\rbac\Role createRole ( $name )
$name | string | The role name
return | yii\rbac\Role | The new Role object

Source code

                    public function createRole($name);

getAssignment() public abstract method

Returns the assignment information regarding a role and a user.

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

Source code

                    public function getAssignment($roleName, $userId);

getAssignments() public abstract method

Returns all role assignment information for the specified user.

public abstract 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.

Source code

                    public function getAssignments($userId);

getChildRoles() public abstract method (available since version 2.0.10)

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

public abstract 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

Source code

                    public function getChildRoles($roleName);

getChildren() public abstract method

Returns the child permissions and/or roles.

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

Source code

                    public function getChildren($name);

getPermission() public abstract method

Returns the named permission.

public abstract yii\rbac\Permission|null getPermission ( $name )
$name | string | The permission name.
return | yii\rbac\Permission|null | The permission corresponding to the specified name. Null is returned if no such permission.

Source code

                    public function getPermission($name);

getPermissions() public abstract method

Returns all permissions in the system.

public abstract yii\rbac\Permission[] getPermissions ( )
return | yii\rbac\Permission[] | All permissions in the system. The array is indexed by the permission names.

Source code

                    public function getPermissions();

getPermissionsByRole() public abstract method

Returns all permissions that the specified role represents.

public abstract 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.

Source code

                    public function getPermissionsByRole($roleName);

getPermissionsByUser() public abstract method

Returns all permissions that the user has.

public abstract 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.

Source code

                    public function getPermissionsByUser($userId);

getRole() public abstract method

Returns the named role.

public abstract yii\rbac\Role|null getRole ( $name )
$name | string | The role name.
return | yii\rbac\Role|null | The role corresponding to the specified name. Null is returned if no such role.

Source code

                    public function getRole($name);

getRoles() public abstract method

Returns all roles in the system.

public abstract yii\rbac\Role[] getRoles ( )
return | yii\rbac\Role[] | All roles in the system. The array is indexed by the role names.

Source code

                    public function getRoles();

getRolesByUser() public abstract 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 abstract 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.

Source code

                    public function getRolesByUser($userId);

getRule() public abstract method

Returns the rule of the specified name.

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

Source code

                    public function getRule($name);

getRules() public abstract method

Returns all rules available in the system.

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

Source code

                    public function getRules();

getUserIdsByRole() public abstract method (available since version 2.0.7)

Returns all user IDs assigned to the role specified.

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

Source code

                    public function getUserIdsByRole($roleName);

hasChild() public abstract method

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

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

Source code

                    public function hasChild($parent, $child);

remove() public abstract method

Removes a role, permission or rule from the RBAC system.

public abstract boolean remove ( $object )
$object | yii\rbac\Role|yii\rbac\Permission|yii\rbac\Rule |
return | boolean | Whether the role, permission or rule is successfully removed

Source code

                    public function remove($object);

removeAll() public abstract method

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

public abstract void removeAll ( )

Source code

                    public function removeAll();

removeAllAssignments() public abstract method

Removes all role assignments.

public abstract void removeAllAssignments ( )

Source code

                    public function removeAllAssignments();

removeAllPermissions() public abstract method

Removes all permissions.

All parent child relations will be adjusted accordingly.

public abstract void removeAllPermissions ( )

Source code

                    public function removeAllPermissions();

removeAllRoles() public abstract method

Removes all roles.

All parent child relations will be adjusted accordingly.

public abstract void removeAllRoles ( )

Source code

                    public function removeAllRoles();

removeAllRules() public abstract method

Removes all rules.

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

public abstract void removeAllRules ( )

Source code

                    public function removeAllRules();

removeChild() public abstract method

Removes a child from its parent.

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

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

Source code

                    public function removeChild($parent, $child);

removeChildren() public abstract method

Removed all children form their parent.

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

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

Source code

                    public function removeChildren($parent);

revoke() public abstract method

Revokes a role from a user.

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

Source code

                    public function revoke($role, $userId);

revokeAll() public abstract method

Revokes all roles from a user.

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

Source code

                    public function revokeAll($userId);

update() public abstract method

Updates the specified role, permission or rule in the system.

public abstract boolean update ( $name, $object )
$name | string | The old name of the role, permission or rule
$object | yii\rbac\Role|yii\rbac\Permission|yii\rbac\Rule |
return | boolean | Whether the update is successful
throws | Exception | if data validation or saving fails (such as the name of the role or permission is not unique)

Source code

                    public function update($name, $object);