PHP Класс yii\rbac\DbManager

The database connection is specified by [[db]]. And the database schema should be as described in "framework/rbac/*.sql". You may change the names of the three tables used to store the authorization data by setting [[itemTable]], [[itemChildTable]] and [[assignmentTable]].
С версии: 2.0
Автор: Qiang Xue ([email protected])
Автор: Alexander Kochetov ([email protected])
Наследование: extends BaseManager
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$assignmentTable the name of the table storing authorization item assignments. Defaults to "auth_assignment".
$cache 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 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 DbManager::invalidateCache to ensure data consistency.
$cacheKey the key used to store RBAC data in cache
$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 the name of the table storing authorization item hierarchy. Defaults to "auth_item_child".
$itemTable the name of the table storing authorization items. Defaults to "auth_item".
$ruleTable the name of the table storing rules. Defaults to "auth_rule".

Защищенные свойства (Protected)

Свойство Тип Описание
$items all auth items (name => Item)
$parents auth item parent-child relationships (childName => list of parents)
$rules all auth rules (name => Rule)

Открытые методы

Метод Описание
addChild ( $parent, $child )
assign ( $role, $userId )
canAddChild ( $parent, $child )
checkAccess ( $userId, $permissionName, $params = [] )
getAssignment ( $roleName, $userId )
getAssignments ( $userId )
getChildRoles ( $roleName )
getChildren ( $name )
getPermissionsByRole ( $roleName )
getPermissionsByUser ( $userId )
getRolesByUser ( $userId )
getRule ( $name )
getRules ( )
getUserIdsByRole ( string $roleName ) : Assignment[] Returns all role assignment information for the specified role.
hasChild ( $parent, $child )
init ( ) Initializes the application component.
invalidateCache ( )
loadFromCache ( )
removeAll ( )
removeAllAssignments ( )
removeAllPermissions ( )
removeAllRoles ( )
removeAllRules ( )
removeChild ( $parent, $child )
removeChildren ( $parent )
revoke ( $role, $userId )
revokeAll ( $userId )

Защищенные методы

Метод Описание
addItem ( $item )
addRule ( $rule )
checkAccessFromCache ( string | integer $user, string $itemName, array $params, Assignment[] $assignments ) : boolean Performs access check for the specified user based on the data loaded from cache.
checkAccessRecursive ( string | integer $user, string $itemName, array $params, Assignment[] $assignments ) : boolean Performs access check for the specified user.
detectLoop ( Item $parent, Item $child ) : boolean Checks whether there is a loop in the authorization item hierarchy.
getChildrenList ( ) : array Returns the children for every parent.
getChildrenRecursive ( string $name, array $childrenList, array &$result ) Recursively finds all children and grand children of the specified item.
getDirectPermissionsByUser ( string | integer $userId ) : Permission[] Returns all permissions that are directly assigned to user.
getInheritedPermissionsByUser ( string | integer $userId ) : Permission[] Returns all permissions that the user inherits from the roles assigned to him.
getItem ( $name )
getItems ( $type )
populateItem ( array $row ) : Item Populates an auth item with the data fetched from database
removeAllItems ( integer $type ) Removes all auth items of the specified type.
removeItem ( $item )
removeRule ( $rule )
supportsCascadeUpdate ( ) : boolean Returns a value indicating whether the database supports cascading update and delete.
updateItem ( $name, $item )
updateRule ( $name, $rule )

Описание методов

addChild() публичный Метод

public addChild ( $parent, $child )

addItem() защищенный Метод

protected addItem ( $item )

addRule() защищенный Метод

protected addRule ( $rule )

assign() публичный Метод

public assign ( $role, $userId )

canAddChild() публичный Метод

С версии: 2.0.8
public canAddChild ( $parent, $child )

checkAccess() публичный Метод

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

checkAccessFromCache() защищенный Метод

This method is internally called by DbManager::checkAccess when [[cache]] is enabled.
С версии: 2.0.3
protected checkAccessFromCache ( string | integer $user, string $itemName, array $params, Assignment[] $assignments ) : boolean
$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 Assignment[] the assignments to the specified user
Результат boolean whether the operations can be performed by the user.

checkAccessRecursive() защищенный Метод

This method is internally called by DbManager::checkAccess.
protected checkAccessRecursive ( string | integer $user, string $itemName, array $params, Assignment[] $assignments ) : boolean
$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 Assignment[] the assignments to the specified user
Результат boolean whether the operations can be performed by the user.

detectLoop() защищенный Метод

Checks whether there is a loop in the authorization item hierarchy.
protected detectLoop ( Item $parent, Item $child ) : boolean
$parent Item the parent item
$child Item the child item to be added to the hierarchy
Результат boolean whether a loop exists

getAssignment() публичный Метод

public getAssignment ( $roleName, $userId )

getAssignments() публичный Метод

public getAssignments ( $userId )

getChildRoles() публичный Метод

public getChildRoles ( $roleName )

getChildren() публичный Метод

public getChildren ( $name )

getChildrenList() защищенный Метод

Returns the children for every parent.
protected getChildrenList ( ) : array
Результат 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() защищенный Метод

Recursively finds all children and grand children of the specified item.
protected getChildrenRecursive ( string $name, array $childrenList, array &$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)

getDirectPermissionsByUser() защищенный Метод

Returns all permissions that are directly assigned to user.
С версии: 2.0.7
protected getDirectPermissionsByUser ( string | integer $userId ) : Permission[]
$userId string | integer the user ID (see [[\yii\web\User::id]])
Результат Permission[] all direct permissions that the user has. The array is indexed by the permission names.

getInheritedPermissionsByUser() защищенный Метод

Returns all permissions that the user inherits from the roles assigned to him.
С версии: 2.0.7
protected getInheritedPermissionsByUser ( string | integer $userId ) : Permission[]
$userId string | integer the user ID (see [[\yii\web\User::id]])
Результат Permission[] all inherited permissions that the user has. The array is indexed by the permission names.

getItem() защищенный Метод

protected getItem ( $name )

getItems() защищенный Метод

protected getItems ( $type )

getPermissionsByRole() публичный Метод

public getPermissionsByRole ( $roleName )

getPermissionsByUser() публичный Метод

public getPermissionsByUser ( $userId )

getRolesByUser() публичный Метод

public getRolesByUser ( $userId )

getRule() публичный Метод

public getRule ( $name )

getRules() публичный Метод

public getRules ( )

getUserIdsByRole() публичный Метод

Returns all role assignment information for the specified role.
С версии: 2.0.7
public getUserIdsByRole ( string $roleName ) : Assignment[]
$roleName string
Результат Assignment[] the assignments. An empty array will be returned if role is not assigned to any user.

hasChild() публичный Метод

public hasChild ( $parent, $child )

init() публичный Метод

This method overrides the parent implementation by establishing the database connection.
public init ( )

invalidateCache() публичный Метод

public invalidateCache ( )

loadFromCache() публичный Метод

public loadFromCache ( )

populateItem() защищенный Метод

Populates an auth item with the data fetched from database
protected populateItem ( array $row ) : Item
$row array the data from the auth item table
Результат Item the populated auth item instance (either Role or Permission)

removeAll() публичный Метод

public removeAll ( )

removeAllAssignments() публичный Метод

removeAllItems() защищенный Метод

Removes all auth items of the specified type.
protected removeAllItems ( integer $type )
$type integer the auth item type (either Item::TYPE_PERMISSION or Item::TYPE_ROLE)

removeAllPermissions() публичный Метод

removeAllRoles() публичный Метод

public removeAllRoles ( )

removeAllRules() публичный Метод

public removeAllRules ( )

removeChild() публичный Метод

public removeChild ( $parent, $child )

removeChildren() публичный Метод

public removeChildren ( $parent )

removeItem() защищенный Метод

protected removeItem ( $item )

removeRule() защищенный Метод

protected removeRule ( $rule )

revoke() публичный Метод

public revoke ( $role, $userId )

revokeAll() публичный Метод

public revokeAll ( $userId )

supportsCascadeUpdate() защищенный Метод

The default implementation will return false for SQLite database and true for all other databases.
protected supportsCascadeUpdate ( ) : boolean
Результат boolean whether the database supports cascading update and delete.

updateItem() защищенный Метод

protected updateItem ( $name, $item )

updateRule() защищенный Метод

protected updateRule ( $name, $rule )

Описание свойств

$assignmentTable публичное свойство

the name of the table storing authorization item assignments. Defaults to "auth_assignment".
public $assignmentTable

$cache публичное свойство

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 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 DbManager::invalidateCache to ensure data consistency.
С версии: 2.0.3
public $cache

$cacheKey публичное свойство

the key used to store RBAC data in cache
См. также: cache
С версии: 2.0.3
public $cacheKey

$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.
public $db

$itemChildTable публичное свойство

the name of the table storing authorization item hierarchy. Defaults to "auth_item_child".
public $itemChildTable

$itemTable публичное свойство

the name of the table storing authorization items. Defaults to "auth_item".
public $itemTable

$items защищенное свойство

all auth items (name => Item)
protected $items

$parents защищенное свойство

auth item parent-child relationships (childName => list of parents)
protected $parents

$ruleTable публичное свойство

the name of the table storing rules. Defaults to "auth_rule".
public $ruleTable

$rules защищенное свойство

all auth rules (name => Rule)
protected $rules