AdminAccessRoleManagerInterface
in
Interface AdminAccessRoleManagerInterface
Tags
Table of Contents
- createNewRole() : AdminAccessRoleInterface
- Creates a new role.
- deleteRole() : AdminAccessRoleManager
- Deletes role by a given role ID.
- getAllRoles() : AdminAccessRoleCollection
- Returns a collection of all roles.
- getRoleById() : AdminAccessRoleInterface
- Returns a role by a given role ID.
- updateRole() : AdminAccessRoleManager
- Updates a role by a given role ID.
Methods
createNewRole()
Creates a new role.
public
createNewRole(KeyValueCollection $name, KeyValueCollection $description, IntType $sortOrder, BoolType $unknownReadingGranted, BoolType $unknownWritingGranted, BoolType $unknownDeletingGranted) : AdminAccessRoleInterface
Parameters
- $name : KeyValueCollection
-
Collection with the role names. Index of a role name must be his language code.
- $description : KeyValueCollection
-
Collection with the role descriptions. Index of a role name must be his language code.
- $sortOrder : IntType
-
Roles sort order.
- $unknownReadingGranted : BoolType
-
Value of the reading permission for unknown groups.
- $unknownWritingGranted : BoolType
-
Value of the writing permission for unknown groups.
- $unknownDeletingGranted : BoolType
-
Value of the deleting permission for unknown groups.
Return values
AdminAccessRoleInterface —Returns the create role.
deleteRole()
Deletes role by a given role ID.
public
deleteRole(IdType $id) : AdminAccessRoleManager
Parameters
- $id : IdType
-
ID of the role that should be deleted.
Return values
AdminAccessRoleManager —Returns same instance for chained method calls.
getAllRoles()
Returns a collection of all roles.
public
getAllRoles() : AdminAccessRoleCollection
Return values
AdminAccessRoleCollection —Role collection with all available roles.
getRoleById()
Returns a role by a given role ID.
public
getRoleById(IdType $id) : AdminAccessRoleInterface
Parameters
- $id : IdType
-
ID of the requested role.
Return values
AdminAccessRoleInterface —updateRole()
Updates a role by a given role ID.
public
updateRole(IdType $id, KeyValueCollection $newName, KeyValueCollection $newDescription, IntType $newSortOrder, BoolType $unknownReadingGranted, BoolType $unknownWritingGranted, BoolType $unknownDeletingGranted) : AdminAccessRoleManager
Parameters
- $id : IdType
-
Role ID to remove permission from.
- $newName : KeyValueCollection
-
Collection with the new role names. Index of a role name must be his language code.
- $newDescription : KeyValueCollection
-
Collection with the new role descriptions. Index of a role name must be his language code.
- $newSortOrder : IntType
-
New roles sort order.
- $unknownReadingGranted : BoolType
-
Value of the reading permission for unknown groups.
- $unknownWritingGranted : BoolType
-
Value of the writing permission for unknown groups.
- $unknownDeletingGranted : BoolType
-
Value of the deleting permission for unknown groups.
Return values
AdminAccessRoleManager —Returns same instance for chained method calls.