Класс yii\rbac\PhpManager

public string $assignmentFile = '@app/rbac/assignments.php'

protected array $assignments = []

protected array $children = []

public string $itemFile = '@app/rbac/items.php'

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

public string $ruleFile = '@app/rbac/rules.php'

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

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[]	Дочерние разрешения и/или роли

getChildrenRecursive() protected method

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

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

getDirectPermissionsByUser() защищённый метод (доступен с версии 2.0.7)

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

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

getInheritedPermissionsByUser() защищённый метод (доступен с версии 2.0.7)

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

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

getItem() публичный метод

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

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

getItems() публичный метод

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

getUserIdsByRole() публичный метод (доступен с версии 2.0.7)

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

публичный массив getUserIdsByRole ( $roleName )
$roleName	строка
return	массив	Массив строк с идентификаторами пользователей

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

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

публичный логическое значение hasChild ( $parent, $child )
$parent	yii\rbac\Item
$child	yii\rbac\Item
return	логическое значение	Является ли $child дочерним элементом $parent

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

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

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

публичный void init ( )

invalidateScriptCache() защищённый метод (доступен с версии 2.0.9)

Отменяет кеширование скомпилированного скрипта (например, OPCache или APC) для указанного файла.

защищённый void invalidateScriptCache ( $file )
$file	строка	Путь к файлу.

load() защищённый метод

Загружает данные авторизации из постоянного хранилища.

защищённый void load ( )

loadFromFile() защищённый метод

Загружает данные авторизации из файла PHP-скрипта.

См. также saveToFile().

защищённый массив loadFromFile ( $file )
$file	строка	Путь к файлу.
return	массив	Данные авторизации

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

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

публичный void removeAll ( )

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

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

публичный void removeAllAssignments ( )

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

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

protected void removeAllItems ( $type )
$type	целое	Тип элемента авторизации (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() public method

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

public boolean removeItem ( $item )
$item	yii\rbac\Item	Удаляемый элемент
return	boolean	Успешно ли удалена роль или разрешение
throws	Исключение	если проверка данных или сохранение не удались (например, имя роли или разрешения не уникально)

removeRule() protected method

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

protected boolean removeRule ( $rule )
$rule	yii\rbac\Rule	Правило для удаления
return	boolean	Успешно ли удалено правило
throws	Исключение	если проверка данных или сохранение не удались (например, имя правила не уникально)

revoke() public method

Лишает пользователя роли.

public boolean revoke ( $role, $userId )
$role	yii\rbac\Role
$userId	строка|целое	Идентификатор пользователя (см. yii\web\User::$id)
return	boolean	Успешно ли выполнена операция лишения

revokeAll() public method

Лишает пользователя всех ролей.

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

save() protected method

Сохраняет данные авторизации в постоянное хранилище.

protected void save ( )

saveAssignments() protected method

Сохраняет данные назначений в постоянное хранилище.

protected void saveAssignments ( )

saveItems() protected method

Сохраняет данные элементов в постоянное хранилище.

protected void saveItems ( )

saveRules() protected method

Сохраняет данные правил в постоянное хранилище.

protected void saveRules ( )

saveToFile() protected method

Сохраняет данные авторизации в файл PHP-скрипта.

См. также loadFromFile().

protected void saveToFile ( $data, $file )
$data	массив	Данные авторизации
$file	строка	Путь к файлу.

updateItem() protected method

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

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

updateRule() public method

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

public boolean updateRule ( $name, $rule )
$name	строка	Имя обновляемого правила
$rule	yii\rbac\Rule	Обновлённое правило
return	boolean	Успешно ли обновлено правило
throws	Исключение	если проверка данных или сохранение не удались (например, имя правила не уникально)