Класс yii\rbac\DbManager

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

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

public yii\caching\CacheInterface|array|string $cache = null

public string $cacheKey = 'rbac'

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

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

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

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

protected array $parents = null

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

public yii\rbac\Rule[] getRules ( )

addChild() public method

Добавляет элемент в качестве потомка другого элемента.

public boolean addChild ( $parent, $child )
$parent	yii\rbac\Item
$child	yii\rbac\Item
return	boolean	Было ли успешно добавлено потомка
throws	yii\base\Exception	если уже существует родитель-потомковая связь или если обнаружен цикл.

addItem() protected method

Добавляет элемент авторизации в систему RBAC.

protected boolean addItem ( $item )
$item	yii\rbac\Item	Добавляемый элемент
return	boolean	Было ли успешно добавлено элемент авторизации в систему
throws	Exception	если проверка данных или сохранение не удалось (например, имя роли или разрешения не уникально)

addRule() protected method

Добавляет правило в систему RBAC.

protected boolean addRule ( $rule )
$rule	yii\rbac\Rule	Правило для добавления
return	boolean	Было ли успешно добавлено правило в систему
throws	Exception	если проверка данных или сохранение не удалось (например, имя правила не уникально)

assign() public method

Назначает роль пользователю.

public yii\rbac\Assignment assign ( $role, $userId )
$role	yii\rbac\Role
$userId	string|integer	Идентификатор пользователя (см. yii\web\User::$id)
return	yii\rbac\Assignment	Информация о назначении роли.
throws	Exception	если роль уже назначена пользователю

canAddChild() public method (доступно начиная с версии 2.0.8)

Проверяет возможность добавления потомка к родителю

public boolean canAddChild ( $parent, $child )
$parent	yii\rbac\Item	Родительский элемент
$child	yii\rbac\Item	Элемент потомка для добавления в иерархию
return	boolean	Возможность добавления

checkAccess() public method

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

checkAccessFromCache() protected method (доступно начиная с версии 2.0.3)

Производит проверку доступа для указанного пользователя на основе данных, загруженных из кэша.

Этот метод вызывается внутренне методом checkAccess(), когда $cache включен.

protected boolean checkAccessFromCache ( $user, $itemName, $params, $assignments )
$user	string|integer	Идентификатор пользователя. Он может быть целым числом или строкой, представляющей уникальный идентификатор пользователя. См. yii\web\User::$id.
$itemName	string	Имя операции, для которой требуется проверка доступа
$params	array	Пара имя-значение, которые будут переданы правилам, связанным с задачами и ролями, назначенными пользователю. В этот массив добавлена пара 'user', содержащая значение $userId.
$assignments	yii\rbac\Assignment[]	Назначения указанному пользователю
return	boolean	Возможно ли выполнить операции пользователю.

checkAccessRecursive() protected method

Выполняет проверку доступа для указанного пользователя.

Этот метод вызывается внутренне методом checkAccess().

protected boolean checkAccessRecursive ( $user, $itemName, $params, $assignments )
$user	string|integer	Идентификатор пользователя. Он может быть целым числом или строкой, представляющей уникальный идентификатор пользователя. См. yii\web\User::$id.
$itemName	string	Имя операции, для которой требуется проверка доступа
$params	array	Пара имя-значение, которые будут переданы правилам, связанным с задачами и ролями, назначенными пользователю. В этот массив добавлена пара 'user', содержащая значение $userId.
$assignments	yii\rbac\Assignment[]	Назначения указанному пользователю
return	boolean	Возможно ли выполнить операции пользователю.

detectLoop() protected method

Проверяет наличие цикла в иерархии элементов авторизации.

protected boolean detectLoop ( $parent, $child )
$parent	yii\rbac\Item	Родительский элемент
$child	yii\rbac\Item	Элемент потомка для добавления в иерархию
return	boolean	Существует ли цикл

getAssignment() public method

Возвращает информацию о назначении роли пользователю.

public null|yii\rbac\Assignment getAssignment ( $roleName, $userId )
$roleName	string	Имя роли
$userId	string|integer	Идентификатор пользователя (см. yii\web\User::$id)
return	null|yii\rbac\Assignment	Информация о назначении. Возвращает Null, если роль не назначена пользователю.

getAssignments() public method

Возвращает всю информацию о назначении ролей для указанного пользователя.

public yii\rbac\Assignment[] getAssignments ( $userId )
$userId	string|integer	Идентификатор пользователя (см. yii\web\User::$id)
return	yii\rbac\Assignment[]	Назначения, индексированные по именам ролей. Возвращает пустой массив, если пользователю не назначены никакие роли.

getChildRoles() public method

Возвращает дочерние роли указанной роли. Глубина не ограничена.

public yii\rbac\Role[] getChildRoles ( $roleName )
$roleName	string	Имя роли, для которой нужно получить дочерние роли
return	yii\rbac\Role[]	Дочерние роли. Массив индексируется по именам ролей. Первый элемент — это экземпляр родительской роли.
throws	yii\base\InvalidParamException	если роль не найдена по имени $roleName

getChildren() public method

Возвращает дочерние разрешения и/или роли.

public yii\rbac\Item[] getChildren ( $name )
$name	string	Имя родителя
return	yii\rbac\Item[]	Дочерние разрешения и/или роли

getChildrenList() protected method

Возвращает дочерние элементы для каждого родительского элемента.

protected array getChildrenList ( )
return	array	Список дочерних элементов. Каждый ключ массива — имя родительского элемента, а соответствующее значение — список имён дочерних элементов.

getChildrenRecursive() protected method

Рекурсивно находит всех потомков и правнуков указанного элемента.

protected void getChildrenRecursive ( $name, $childrenList, &$result )
$name	string	Имя элемента, для которого нужно найти потомков.
$childrenList	array	Список дочерних элементов, полученный с помощью getChildrenList()
$result	array	Потомки и правнуки (в качестве ключей массива)

getDirectPermissionsByUser() protected method (available since version 2.0.7)

Возвращает все разрешения, непосредственно назначенные пользователю.

protected yii\rbac\Permission[] getDirectPermissionsByUser ( $userId )
$userId	string|integer	Идентификатор пользователя (см. yii\web\User::$id)
return	yii\rbac\Permission[]	Все прямые разрешения, имеющиеся у пользователя. Массив индексируется по именам разрешений.

getInheritedPermissionsByUser() protected method (available since version 2.0.7)

Возвращает все разрешения, унаследованные пользователем от ролей, назначенных ему.

protected yii\rbac\Permission[] getInheritedPermissionsByUser ( $userId )
$userId	string|integer	Идентификатор пользователя (см. yii\web\User::$id)
return	yii\rbac\Permission[]	Все унаследованные разрешения, имеющиеся у пользователя. Массив индексируется по именам разрешений.

getItem() protected method

Возвращает элемент авторизации по имени.

protected yii\rbac\Item getItem ( $name )
$name	string	Имя элемента авторизации.
return	yii\rbac\Item	Элемент авторизации, соответствующий указанному имени. Возвращает null, если элемент не найден.

getItems() protected method

Возвращает элементы указанного типа.

protected yii\rbac\Item[] getItems ( $type )
$type	integer	Тип элемента авторизации (либо yii\rbac\Item::TYPE_ROLE, либо yii\rbac\Item::TYPE_PERMISSION)
return	yii\rbac\Item[]	Элементы авторизации указанного типа.

getPermissionsByRole() public method

Возвращает все разрешения, представленные указанной ролью.

public yii\rbac\Permission[] getPermissionsByRole ( $roleName )
$roleName	string	Имя роли
return	yii\rbac\Permission[]	Все разрешения, представленные ролью. Массив индексируется по именам разрешений.

getPermissionsByUser() public method

Возвращает все разрешения, имеющиеся у пользователя.

public yii\rbac\Permission[] getPermissionsByUser ( $userId )
$userId	string|integer	Идентификатор пользователя (см. yii\web\User::$id)
return	yii\rbac\Permission[]	Все разрешения, имеющиеся у пользователя. Массив индексируется по именам разрешений.

getRolesByUser() public method

Возвращает роли, назначенные пользователю с помощью assign().

Обратите внимание, что дочерние роли, которые не назначены напрямую пользователю, не будут возвращены.

public yii\rbac\Role[] getRolesByUser ( $userId )
$userId	string|integer	Идентификатор пользователя (см. yii\web\User::$id)
return	yii\rbac\Role[]	Все роли, непосредственно назначенные пользователю. Массив индексируется по именам ролей.

getRule() public method

Возвращает правило с заданным именем.

public null|yii\rbac\Rule getRule ( $name )
$name	string	Имя правила
return	null|yii\rbac\Rule	Объект правила или null, если указанное имя не соответствует ни одному правилу.

getRules() public method

Возвращает все доступные правила системы.

public yii\rbac\Rule[] getRules ( )
return	yii\rbac\Rule[]	Правила, индексированные по именам правил

getUserIdsByRole() public method (available since version 2.0.7)

Возвращает информацию о назначении ролей для указанной роли.

public string[] getUserIdsByRole ( $roleName )
$roleName	string
return	string[]	Идентификаторы. Если роль не назначена ни одному пользователю, возвращается пустой массив.

hasChild() public method

Возвращает значение, указывающее, существует ли дочерний элемент для родительского элемента.

public boolean hasChild ( $parent, $child )
$parent	yii\rbac\Item
$child	yii\rbac\Item
return	boolean	Является ли $child потомком $parent

init() public method

Инициализирует компонент приложения.

Этот метод переопределяет реализацию родительского класса, устанавливая соединение с базой данных.

public void init ( )

invalidateCache() public method

public void invalidateCache ( )

loadFromCache() public method

public void loadFromCache ( )

populateItem() protected method

Заполняет элемент авторизации данными, извлеченными из базы данных

protected yii\rbac\Item populateItem ( $row )
$row	array	Данные из таблицы элементов авторизации
return	yii\rbac\Item	Экземпляр заполненного элемента авторизации (либо Роль, либо Разрешение)

removeAll() public method

Удаляет все данные авторизации, включая роли, разрешения, правила и назначения.

public void removeAll ( )

removeAllAssignments() public method

Удаляет все назначения ролей.

public void removeAllAssignments ( )

removeAllItems() protected method

Удаляет все элементы авторизации указанного типа.

protected void removeAllItems ( $type )
$type	integer	Тип элемента авторизации (либо Item::TYPE_PERMISSION, либо Item::TYPE_ROLE)

removeAllPermissions() public method

Удаляет все разрешения.

Все отношения "родитель-потомок" будут соответствующим образом скорректированы.

public void removeAllPermissions ( )

removeAllRoles() public method

Удаляет все роли.

Все отношения "родитель-потомок" будут соответствующим образом скорректированы.

public void removeAllRoles ( )

removeAllRules() public method

Удаляет все правила.

Все роли и разрешения, имеющие правила, будут соответствующим образом скорректированы.

public void removeAllRules ( )

removeChild() public method

Удаляет потомка из родительской структуры.

Обратите внимание, что сам элемент-потомок не удаляется. Удаляется только родительско-потомок отношение.

public boolean removeChild ( $parent, $child )
$parent	yii\rbac\Item
$child	yii\rbac\Item
return	boolean	Успешность удаления

removeChildren() public method

Удаляет всех потомков из родительской структуры.

Обратите внимание, что сами элементы-потомки не удаляются. Удаляются только родительско-потомок отношения.

public boolean removeChildren ( $parent )
$parent	yii\rbac\Item
return	boolean	Успешность удаления

removeItem() protected method

Удаляет элемент авторизации из системы RBAC.

protected boolean removeItem ( $item )
$item	yii\rbac\Item	Элемент для удаления
return	boolean	Успешность удаления роли или разрешения
throws	Exception	если произошла ошибка валидации или сохранения (например, имя роли или разрешения не уникально)

removeRule() protected method

Удаляет правило из системы RBAC.

protected boolean removeRule ( $rule )
$rule	yii\rbac\Rule	Правило для удаления
return	boolean	Успешность удаления правила
throws	Exception	если произошла ошибка валидации или сохранения (например, имя правила не уникально)

revoke() public method

Отзывает роль у пользователя.

public boolean revoke ( $role, $userId )
$role	yii\rbac\Role
$userId	string|integer	ID пользователя (см. yii\web\User::$id)
return	boolean	Успешность отзыва

revokeAll() public method

Отзывает все роли у пользователя.

public boolean revokeAll ( $userId )
$userId	mixed	ID пользователя (см. yii\web\User::$id)
return	boolean	Успешность отзыва

supportsCascadeUpdate() protected method

Возвращает значение, указывающее, поддерживает ли база данных каскадное обновление и удаление.

Реализация по умолчанию вернет false для SQLite базы данных и true для всех других баз данных.

protected boolean supportsCascadeUpdate ( )
return	boolean	Поддерживает ли база данных каскадное обновление и удаление.

updateItem() protected method

Обновляет элемент авторизации в системе RBAC.

protected boolean updateItem ( $name, $item )
$name	string	Имя обновляемого элемента
$item	yii\rbac\Item	Обновленный элемент
return	boolean	Успешность обновления элемента авторизации
throws	Exception	если произошла ошибка валидации или сохранения (например, имя роли или разрешения не уникально)

updateRule() protected method

Обновляет правило в системе RBAC.

protected boolean updateRule ( $name, $rule )
$name	string	Имя обновляемого правила
$rule	yii\rbac\Rule	Обновленное правило
return	boolean	Успешность обновления правила
throws	Exception	если произошла ошибка валидации или сохранения (например, имя правила не уникально)