• Home
• yii
• rbac
• PhpManager

PHP Class yii\rbac\PhpManager

The authorization data will be saved to and loaded from a file specified by [[authFile]], which defaults to 'protected/data/rbac.php'. PhpManager is mainly suitable for authorization data that is not too big (for example, the authorization data for a personal blog system). Use DbManager for more complex authorization data. Datei anzeigen Open project: yiisoft/yii2 Class Usage Examples

Public Properties

Property	Type	Description
$assignmentFile		the path of the PHP script that contains the authorization assignments. This can be either a file path or a path alias to the file. Make sure this file is writable by the Web server process if the authorization needs to be changed online.
$itemFile		the path of the PHP script that contains the authorization items. This can be either a file path or a path alias to the file. Make sure this file is writable by the Web server process if the authorization needs to be changed online.
$ruleFile		the path of the PHP script that contains the authorization rules. This can be either a file path or a path alias to the file. Make sure this file is writable by the Web server process if the authorization needs to be changed online.

Protected Properties

Property	Type	Description
$assignments	array
$children	array
$items	Item[]
$rules	Rule[]

Public Methods

Method	Description
addChild ( $parent, $child )
assign ( $role, $userId )
canAddChild ( $parent, $child )
checkAccess ( $userId, $permissionName, $params = [] )
getAssignment ( $roleName, $userId )
getAssignments ( $userId )
getChildRoles ( $roleName )
getChildren ( $name )
getItem ( $name )
getItems ( $type )
getPermissionsByRole ( $roleName )
getPermissionsByUser ( $userId )
getRolesByUser ( $userId )
getRule ( $name )
getRules ( )
getUserIdsByRole ( $roleName )
hasChild ( $parent, $child )
init ( )	Initializes the application component.
removeAll ( )
removeAllAssignments ( )
removeAllPermissions ( )
removeAllRoles ( )
removeAllRules ( )
removeChild ( $parent, $child )
removeChildren ( $parent )
removeItem ( $item )
revoke ( $role, $userId )
revokeAll ( $userId )
updateRule ( $name, $rule )

Protected Methods

Method	Description
addItem ( $item )
addRule ( $rule )
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.
getChildrenRecursive ( string $name, 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.
invalidateScriptCache ( string $file )	Invalidates precompiled script cache (such as OPCache or APC) for the given file.
load ( )	Loads authorization data from persistent storage.
loadFromFile ( string $file ) : array	Loads the authorization data from a PHP script file.
removeAllItems ( integer $type )	Removes all auth items of the specified type.
removeRule ( $rule )
save ( )	Saves authorization data into persistent storage.
saveAssignments ( )	Saves assignments data into persistent storage.
saveItems ( )	Saves items data into persistent storage.
saveRules ( )	Saves rules data into persistent storage.
saveToFile ( array $data, string $file )	Saves the authorization data to a PHP script file.
updateItem ( $name, $item )

Method Details

Property Details