0 follower

Interface Yiisoft\Rbac\ManagerInterface

All Classes | Methods

Extends	Yiisoft\Access\AccessCheckerInterface
Implemented by	Yiisoft\Rbac\Manager

An interface for managing RBAC entities (items, assignments, rules) with possibility to check user permissions.

Public Methods

Hide inherited methods

Method	Description	Defined By
addChild()	Adds an item as a child of another item.	Yiisoft\Rbac\ManagerInterface
addPermission()		Yiisoft\Rbac\ManagerInterface
addRole()		Yiisoft\Rbac\ManagerInterface
assign()	Assigns a role or permission to a user.	Yiisoft\Rbac\ManagerInterface
canAddChild()	Checks the possibility of adding a child to a parent.	Yiisoft\Rbac\ManagerInterface
getChildRoles()	Returns child roles of the role specified. Depth isn't limited.	Yiisoft\Rbac\ManagerInterface
getDefaultRoleNames()	Returns default role names.	Yiisoft\Rbac\ManagerInterface
getDefaultRoles()	Returns default roles.	Yiisoft\Rbac\ManagerInterface
getGuestRole()	Get a guest role.	Yiisoft\Rbac\ManagerInterface
getGuestRoleName()	Get guest role name.	Yiisoft\Rbac\ManagerInterface
getItemsByUserId()	Returns the items that are assigned to the user via assign().	Yiisoft\Rbac\ManagerInterface
getPermission()		Yiisoft\Rbac\ManagerInterface
getPermissionsByRoleName()	Returns all permissions that the specified role represents.	Yiisoft\Rbac\ManagerInterface
getPermissionsByUserId()	Returns all permissions that the user has.	Yiisoft\Rbac\ManagerInterface
getRole()		Yiisoft\Rbac\ManagerInterface
getRolesByUserId()	Returns the roles that are assigned to the user via assign().	Yiisoft\Rbac\ManagerInterface
getUserIdsByRoleName()	Returns all user IDs assigned to the role specified.	Yiisoft\Rbac\ManagerInterface
hasChild()	Returns a value indicating whether the child already exists for the parent.	Yiisoft\Rbac\ManagerInterface
hasChildren()	Returns whether named parent has children.	Yiisoft\Rbac\ManagerInterface
removeChild()	Removes a child from its parent.	Yiisoft\Rbac\ManagerInterface
removeChildren()	Removes all children form their parent.	Yiisoft\Rbac\ManagerInterface
removePermission()		Yiisoft\Rbac\ManagerInterface
removeRole()		Yiisoft\Rbac\ManagerInterface
revoke()	Revokes a role or a permission from a user.	Yiisoft\Rbac\ManagerInterface
revokeAll()	Revokes all roles and permissions from a user.	Yiisoft\Rbac\ManagerInterface
setDefaultRoleNames()	Set default role names.	Yiisoft\Rbac\ManagerInterface
setGuestRoleName()	Set guest role name.	Yiisoft\Rbac\ManagerInterface
updatePermission()		Yiisoft\Rbac\ManagerInterface
updateRole()		Yiisoft\Rbac\ManagerInterface

Method Details

Hide inherited methods

addChild() public abstract method

Adds an item as a child of another item.

public abstract addChild( string $parentName, string $childName ): self
$parentName	string	The name of the parent item.
$childName	string	The name of the child item.
throws	RuntimeException
throws	InvalidArgumentException

Source code

                public function addChild(string $parentName, string $childName): self;

addPermission() public abstract method

public abstract addPermission( Yiisoft\Rbac\Permission $permission ): self
$permission	Yiisoft\Rbac\Permission
throws	Yiisoft\Rbac\Exception\ItemAlreadyExistsException

Source code

                public function addPermission(Permission $permission): self;

addRole() public abstract method

public abstract addRole( Yiisoft\Rbac\Role $role ): self
$role	Yiisoft\Rbac\Role
throws	Yiisoft\Rbac\Exception\ItemAlreadyExistsException

Source code

                public function addRole(Role $role): self;

assign() public abstract method

Assigns a role or permission to a user.

public abstract assign( string $itemName, integer\|string\|\Stringable $userId, integer\|null $createdAt = null ): self
$itemName	string	Name of the role or the permission to be assigned.
$userId	integer\|string\|\Stringable	The user ID.
$createdAt	integer\|null	UNIX timestamp representing assignment creation time. When `null`, current time is used.
throws	InvalidArgumentException	If an item with the given name is not found. During the attempt of assigning permissions directly when it's disabled.

Source code

                public function assign(string $itemName, int|Stringable|string $userId, ?int $createdAt = null): self;

canAddChild() public abstract method

Checks the possibility of adding a child to a parent.

public abstract canAddChild( string $parentName, string $childName ): boolean
$parentName	string	The name of the parent item.
$childName	string	The name of the child item to be added to the hierarchy.
return	boolean	Whether it is possible to add the child to the parent.

Source code

                public function canAddChild(string $parentName, string $childName): bool;

getChildRoles() public abstract method

Returns child roles of the role specified. Depth isn't limited.

public abstract getChildRoles( string $roleName ): Yiisoft\Rbac\Role[]
$roleName	string	Name of the role to get child roles for.
return	Yiisoft\Rbac\Role[]	Child roles. The array is indexed by the role names.
throws	InvalidArgumentException	If the role was not found by `$roleName`.

Source code

                public function getChildRoles(string $roleName): array;

getDefaultRoleNames() public abstract method

Returns default role names.

public abstract getDefaultRoleNames( ): string[]
return	string[]	Default role names.

Source code

                public function getDefaultRoleNames(): array;

getDefaultRoles() public abstract method

Returns default roles.

public abstract getDefaultRoles( ): Yiisoft\Rbac\Role[]
return	Yiisoft\Rbac\Role[]	Default roles. The array is indexed by the role names.
throws	Yiisoft\Rbac\Exception\DefaultRolesNotFoundException	When at least 1 of the default roles was not found.

Source code

                public function getDefaultRoles(): array;

getGuestRole() public abstract method

Get a guest role.

public abstract getGuestRole( ): Yiisoft\Rbac\Role\|null
return	Yiisoft\Rbac\Role\|null	Guest role or `null` if the name was not set.
throws	InvalidArgumentException	When a role was not found.

Source code

                public function getGuestRole(): ?Role;

getGuestRoleName() public abstract method

Get guest role name.

public abstract getGuestRoleName( ): string\|null
return	string\|null	The guest role name or `null` if it was not set.

Source code

                public function getGuestRoleName(): ?string;

getItemsByUserId() public abstract method

Returns the items that are assigned to the user via assign().

public abstract getItemsByUserId( integer\|string\|\Stringable $userId ): array
$userId	integer\|string\|\Stringable	The user ID.
return	array	All items directly assigned to the user. The array is indexed by the item names.

Source code

                public function getItemsByUserId(int|Stringable|string $userId): array;

getPermission() public abstract method

public abstract getPermission( string $name ): Yiisoft\Rbac\Permission\|null
$name	string	The permission name.

Source code

                public function getPermission(string $name): ?Permission;

getPermissionsByRoleName() public abstract method

Returns all permissions that the specified role represents.

public abstract getPermissionsByRoleName( string $roleName ): Yiisoft\Rbac\Permission[]
$roleName	string	The role name.
return	Yiisoft\Rbac\Permission[]	All permissions that the role represents. The array is indexed by the permission names.

Source code

                public function getPermissionsByRoleName(string $roleName): array;

getPermissionsByUserId() public abstract method

Returns all permissions that the user has.

public abstract getPermissionsByUserId( integer\|string\|\Stringable $userId ): Yiisoft\Rbac\Permission[]
$userId	integer\|string\|\Stringable	The user ID.
return	Yiisoft\Rbac\Permission[]	All permissions that the user has. The array is indexed by the permission names.

Source code

                public function getPermissionsByUserId(int|Stringable|string $userId): array;

getRole() public abstract method

public abstract getRole( string $name ): Yiisoft\Rbac\Role\|null
$name	string	The role name.

Source code

                public function getRole(string $name): ?Role;

getRolesByUserId() public abstract method

Returns the roles that are assigned to the user via assign().

public abstract getRolesByUserId( integer\|string\|\Stringable $userId ): Yiisoft\Rbac\Role[]
$userId	integer\|string\|\Stringable	The user ID.
return	Yiisoft\Rbac\Role[]	All roles directly assigned to the user. The array is indexed by the role names.

Source code

                public function getRolesByUserId(int|Stringable|string $userId): array;

getUserIdsByRoleName() public abstract method

Returns all user IDs assigned to the role specified.

public abstract getUserIdsByRoleName( string $roleName ): array
$roleName	string	The role name.
return	array	Array of user ID strings.

Source code

                public function getUserIdsByRoleName(string $roleName): array;

hasChild() public abstract method

Returns a value indicating whether the child already exists for the parent.

public abstract hasChild( string $parentName, string $childName ): boolean
$parentName	string	The name of the parent item.
$childName	string	The name of the child item.
return	boolean	Whether `$child` is already a child of `$parent`

Source code

                public function hasChild(string $parentName, string $childName): bool;

hasChildren() public abstract method

Returns whether named parent has children.

public abstract hasChildren( string $parentName ): boolean
$parentName	string	The parent name.
return	boolean	Whether named parent has children.

Source code

                public function hasChildren(string $parentName): bool;

removeChild() public abstract method

Removes a child from its parent.

Note, the child item is not deleted. Only the parent-child relationship is removed.

public abstract removeChild( string $parentName, string $childName ): self
$parentName	string	The name of the parent item.
$childName	string	The name of the child item.

Source code

                public function removeChild(string $parentName, string $childName): self;

removeChildren() public abstract method

Removes all children form their parent.

Note, the children items are not deleted. Only the parent-child relationships are removed.

public abstract removeChildren( string $parentName ): self
$parentName	string	The name of the parent item.

Source code

                public function removeChildren(string $parentName): self;

removePermission() public abstract method

public abstract removePermission( string $name ): self
$name	string	The permission name.

Source code

                public function removePermission(string $name): self;

removeRole() public abstract method

public abstract removeRole( string $name ): self
$name	string	The role name.

Source code

                public function removeRole(string $name): self;

revoke() public abstract method

Revokes a role or a permission from a user.

public abstract revoke( string $itemName, integer\|string\|\Stringable $userId ): self
$itemName	string	The name of the role or permission to be revoked.
$userId	integer\|string\|\Stringable	The user ID.

Source code

                public function revoke(string $itemName, int|Stringable|string $userId): self;

revokeAll() public abstract method

Revokes all roles and permissions from a user.

public abstract revokeAll( integer\|string\|\Stringable $userId ): self
$userId	integer\|string\|\Stringable	The user ID.

Source code

                public function revokeAll(int|Stringable|string $userId): self;

setDefaultRoleNames() public abstract method

Set default role names.

public abstract setDefaultRoleNames( array\|Closure $roleNames ): self
$roleNames	array\|Closure	Either array of role names or a closure returning it.
throws	InvalidArgumentException	When role names is not a list of strings passed directly or resolved from a closure.

Source code

                public function setDefaultRoleNames(array|Closure $roleNames): self;

setGuestRoleName() public abstract method

Set guest role name.

public abstract setGuestRoleName( string\|null $name ): self
$name	string\|null	The guest role name.

Source code

                public function setGuestRoleName(?string $name): self;

updatePermission() public abstract method

public abstract updatePermission( string $name, Yiisoft\Rbac\Permission $permission ): self
$name	string	The permission name.
$permission	Yiisoft\Rbac\Permission	Permission instance with updated data.

Source code

                public function updatePermission(string $name, Permission $permission): self;

updateRole() public abstract method

public abstract updateRole( string $name, Yiisoft\Rbac\Role $role ): self
$name	string	The role name.
$role	Yiisoft\Rbac\Role	Role instance with updated data.

Source code

                public function updateRole(string $name, Role $role): self;