Class yii\rbac\DbManager

Inheritanceyii\rbac\DbManager » yii\rbac\BaseManager » yii\base\Component » yii\base\Object
Implementsyii\base\Configurable, yii\rbac\ManagerInterface
Available since version2.0
Source Code https://github.com/yiisoft/yii2/blob/master/framework/rbac/DbManager.php

DbManager represents an authorization manager that stores authorization information in database.

The database connection is specified by $db. The database schema could be initialized by applying migration:

yii migrate --migrationPath=@yii/rbac/migrations/

If you don't want to use migration and need SQL instead, files for all databases are in migrations directory.

You may change the names of the tables used to store the authorization and rule data by setting $itemTable, $itemChildTable, $assignmentTable and $ruleTable.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$assignmentTable string The name of the table storing authorization item assignments. yii\rbac\DbManager
$behaviors yii\base\Behavior[] List of behaviors attached to this component yii\base\Component
$cache yii\caching\Cache|array|string The cache used to improve RBAC performance. yii\rbac\DbManager
$cacheKey string The key used to store RBAC data in cache yii\rbac\DbManager
$db yii\db\Connection|array|string The DB connection object or the application component ID of the DB connection. yii\rbac\DbManager
$defaultRoles array A list of role names that are assigned to every user automatically without calling assign(). yii\rbac\BaseManager
$itemChildTable string The name of the table storing authorization item hierarchy. yii\rbac\DbManager
$itemTable string The name of the table storing authorization items. yii\rbac\DbManager
$permissions yii\rbac\Permission[] All permissions in the system. yii\rbac\BaseManager
$roles yii\rbac\Role[] All roles in the system. yii\rbac\BaseManager
$ruleTable string The name of the table storing rules. yii\rbac\DbManager

Protected Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$items yii\rbac\Item[] All auth items (name => Item) yii\rbac\DbManager
$parents array Auth item parent-child relationships (childName => list of parents) yii\rbac\DbManager
$rules yii\rbac\Rule[] All auth rules (name => Rule) yii\rbac\DbManager

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. yii\base\Component
__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 a component property. yii\base\Component
__isset() Checks if a property is set, i.e. defined and not null. yii\base\Component
__set() Sets the value of a component property. yii\base\Component
__unset() Sets a component property to be null. yii\base\Component
add() Adds a role, permission or rule to the RBAC system. yii\rbac\BaseManager
addChild() Adds an item as a child of another item. yii\rbac\DbManager
assign() Assigns a role to a user. yii\rbac\DbManager
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\Component
canSetProperty() Returns a value indicating whether a property can be set. yii\base\Component
checkAccess() Checks if the user has the specified permission. yii\rbac\DbManager
className() Returns the fully qualified name of this class. yii\base\Object
createPermission() Creates a new Permission object. yii\rbac\BaseManager
createRole() Creates a new Role object. yii\rbac\BaseManager
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
getAssignment() Returns the assignment information regarding a role and a user. yii\rbac\DbManager
getAssignments() Returns all role assignment information for the specified user. yii\rbac\DbManager
getBehavior() Returns the named behavior object. yii\base\Component
getBehaviors() Returns all behaviors attached to this component. yii\base\Component
getChildren() Returns the child permissions and/or roles. yii\rbac\DbManager
getPermission() Returns the named permission. yii\rbac\BaseManager
getPermissions() Returns all permissions in the system. yii\rbac\BaseManager
getPermissionsByRole() Returns all permissions that the specified role represents. yii\rbac\DbManager
getPermissionsByUser() Returns all permissions that the user has. yii\rbac\DbManager
getRole() Returns the named role. yii\rbac\BaseManager
getRoles() Returns all roles in the system. yii\rbac\BaseManager
getRolesByUser() Returns the roles that are assigned to the user via assign(). yii\rbac\DbManager
getRule() Returns the rule of the specified name. yii\rbac\DbManager
getRules() Returns all rules available in the system. yii\rbac\DbManager
hasChild() Returns a value indicating whether the child already exists for the parent. yii\rbac\DbManager
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\Component
hasProperty() Returns a value indicating whether a property is defined for this component. yii\base\Component
init() Initializes the application component. yii\rbac\DbManager
invalidateCache() yii\rbac\DbManager
loadFromCache() yii\rbac\DbManager
off() Detaches an existing event handler from this component. yii\base\Component
on() Attaches an event handler to an event. yii\base\Component
remove() Removes a role, permission or rule from the RBAC system. yii\rbac\BaseManager
removeAll() Removes all authorization data, including roles, permissions, rules, and assignments. yii\rbac\DbManager
removeAllAssignments() Removes all role assignments. yii\rbac\DbManager
removeAllPermissions() Removes all permissions. yii\rbac\DbManager
removeAllRoles() Removes all roles. yii\rbac\DbManager
removeAllRules() Removes all rules. yii\rbac\DbManager
removeChild() Removes a child from its parent. yii\rbac\DbManager
removeChildren() Removed all children form their parent. yii\rbac\DbManager
revoke() Revokes a role from a user. yii\rbac\DbManager
revokeAll() Revokes all roles from a user. yii\rbac\DbManager
trigger() Triggers an event. yii\base\Component
update() Updates the specified role, permission or rule in the system. yii\rbac\BaseManager

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
addItem() Adds an auth item to the RBAC system. yii\rbac\DbManager
addRule() Adds a rule to the RBAC system. yii\rbac\DbManager
checkAccessFromCache() Performs access check for the specified user based on the data loaded from cache. yii\rbac\DbManager
checkAccessRecursive() Performs access check for the specified user. yii\rbac\DbManager
detectLoop() Checks whether there is a loop in the authorization item hierarchy. yii\rbac\DbManager
executeRule() Executes the rule associated with the specified auth item. yii\rbac\BaseManager
getChildrenList() Returns the children for every parent. yii\rbac\DbManager
getChildrenRecursive() Recursively finds all children and grand children of the specified item. yii\rbac\DbManager
getItem() Returns the named auth item. yii\rbac\DbManager
getItems() Returns the items of the specified type. yii\rbac\DbManager
populateItem() Populates an auth item with the data fetched from database yii\rbac\DbManager
removeAllItems() Removes all auth items of the specified type. yii\rbac\DbManager
removeItem() Removes an auth item from the RBAC system. yii\rbac\DbManager
removeRule() Removes a rule from the RBAC system. yii\rbac\DbManager
supportsCascadeUpdate() Returns a value indicating whether the database supports cascading update and delete. yii\rbac\DbManager
updateItem() Updates an auth item in the RBAC system. yii\rbac\DbManager
updateRule() Updates a rule to the RBAC system. yii\rbac\DbManager

Property Details

$assignmentTable public property
string $assignmentTable = '{{%auth_assignment}}'

The name of the table storing authorization item assignments. Defaults to "auth_assignment".

$cache public property (available since version 2.0.3)
yii\caching\Cache|array|string $cache = null

The cache used to improve RBAC performance. This can be one of the following:

  • an application component ID (e.g. cache)
  • a configuration array
  • a \yii\rbac\yii\caching\Cache object

When this is not set, it means caching is not enabled.

Note that by enabling RBAC cache, all auth items, rules and auth item parent-child relationships will be cached and loaded into memory. This will improve the performance of RBAC permission check. However, it does require extra memory and as a result may not be appropriate if your RBAC system contains too many auth items. You should seek other RBAC implementations (e.g. RBAC based on Redis storage) in this case.

Also note that if you modify RBAC items, rules or parent-child relationships from outside of this component, you have to manually call invalidateCache() to ensure data consistency.

$cacheKey public property (available since version 2.0.3)
string $cacheKey = 'rbac'

The key used to store RBAC data in cache

See also $cache.

$db public property
yii\db\Connection|array|string $db = 'db'

The DB connection object or the application component ID of the DB connection. After the DbManager object is created, if you want to change this property, you should only assign it with a DB connection object. Starting from version 2.0.2, this can also be a configuration array for creating the object.

$itemChildTable public property
string $itemChildTable = '{{%auth_item_child}}'

The name of the table storing authorization item hierarchy. Defaults to "auth_item_child".

$itemTable public property
string $itemTable = '{{%auth_item}}'

The name of the table storing authorization items. Defaults to "auth_item".

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

All auth items (name => Item)

$parents protected property
array $parents = null

Auth item parent-child relationships (childName => list of parents)

$ruleTable public property
string $ruleTable = '{{%auth_rule}}'

The name of the table storing rules. Defaults to "auth_rule".

$rules protected read-only property
yii\rbac\Rule[] getRules( )

All auth rules (name => Rule)

Method Details

addChild() public method

Adds an item as a child of another item.

void addChild( $parent, $child )
$parent yii\rbac\Item
$child yii\rbac\Item
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.

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.

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.

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
checkAccess() public method

Checks if the user has the specified permission.

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
checkAccessFromCache() protected method (available since version 2.0.3)

Performs access check for the specified user based on the data loaded from cache.

This method is internally called by checkAccess() when $cache is enabled.

boolean checkAccessFromCache( $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.
checkAccessRecursive() protected method

Performs access check for the specified user.

This method is internally called by checkAccess().

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.

boolean detectLoop( $parent, $child )
$parent yii\rbac\Item

The parent item
$child yii\rbac\Item

The child item 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.

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.

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.
getChildren() public method

Returns the child permissions and/or roles.

yii\rbac\Item[] getChildren( $name )
$name string

The parent name
return yii\rbac\Item[]

The child permissions and/or roles
getChildrenList() protected method

Returns the children for every parent.

array getChildrenList( )
return array

The children list. Each array key is a parent item name, and the corresponding array value is a list of child item names.
getChildrenRecursive() protected method

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

void getChildrenRecursive( $name, $childrenList, <b>&</b>$result )
$name string

The name of the item whose children are to be looked for.
$childrenList array

The child list built via getChildrenList()
$result array

The children and grand children (in array keys)
getItem() protected method

Returns the named auth item.

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() protected method

Returns the items of the specified type.

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.

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.

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.

yii\rbac\Role[] getRolesByUser( $userId )
$userId string|integer

The user ID (see yii\web\User::$id)
return yii\rbac\Role[]

All roles directly or indirectly assigned to the user. The array is indexed by the role names.
getRule() public method

Returns the rule of the specified name.

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.

yii\rbac\Rule[] getRules( )
return yii\rbac\Rule[]

The rules indexed by the rule names
hasChild() public method

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

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 the parent implementation by establishing the database connection.

void init( )
invalidateCache() public method

void invalidateCache( )
loadFromCache() public method

void loadFromCache( )
populateItem() protected method

Populates an auth item with the data fetched from database

yii\rbac\Item populateItem( $row )
$row array

The data from the auth item table
return yii\rbac\Item

The populated auth item instance (either Role or Permission)
removeAll() public method

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

void removeAll( )
removeAllAssignments() public method

Removes all role assignments.

void removeAllAssignments( )
removeAllItems() protected method

Removes all auth items of the specified type.

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.

void removeAllPermissions( )
removeAllRoles() public method

Removes all roles.

All parent child relations will be adjusted accordingly.

void removeAllRoles( )
removeAllRules() public method

Removes all rules.

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

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.

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.

boolean removeChildren( $parent )
$parent yii\rbac\Item
return boolean

Whether the removal is successful
removeItem() protected method

Removes an auth item from the RBAC system.

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.

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.

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.

boolean revokeAll( $userId )
$userId mixed

The user ID (see yii\web\User::$id)
return boolean

Whether the revoking is successful
supportsCascadeUpdate() protected method

Returns a value indicating whether the database supports cascading update and delete.

The default implementation will return false for SQLite database and true for all other databases.

boolean supportsCascadeUpdate( )
return boolean

Whether the database supports cascading update and delete.
updateItem() protected method

Updates an auth item in the RBAC system.

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() protected method

Updates a rule to the RBAC system.

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)