Класс yii\mongodb\rbac\MongoDbManager

public string|array $assignmentCollection = 'auth_assignment'

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

public string $cacheKey = 'rbac'

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

public string|array $itemCollection = 'auth_item'

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

public string|array $ruleCollection = '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	ID пользователя (см. yii\web\User::$id)
return	yii\rbac\Assignment	Информация о назначении роли.
throws	Exception	если роль уже назначена пользователю

canAddChild() public method

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

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

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

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

protected boolean checkAccessFromCache ( $user, $itemName, $params, $assignments )
$user	string|integer	ID пользователя. Это может быть целое число или строка, представляющая уникальный идентификатор пользователя. См. 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	ID пользователя. Это может быть целое число или строка, представляющая уникальный идентификатор пользователя. См. 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	ID пользователя (см. yii\web\User::$id)
return	null|yii\rbac\Assignment	Информация о назначении. Возвращает Null, если роль не назначена пользователю.

getAssignments() public method

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

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

getChildRoles() public method (доступно с версии 2.1.2)

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

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	Потомки и правнуки (в качестве ключей массива)

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

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

public array getUserIdsByRole ( $roleName )
$roleName	string
return	array	Массив строк с идентификаторами пользователей

hasChild() public method

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

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

init() public method

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

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

public void init ( )

invalidateCache() public method

Очищает кэш, связанный с RBAC

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	Успешность лишения прав

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	Если проверка данных или сохранение завершилось неудачно (например, имя правила не уникально)