Interface AdminAccessRoleManagerInterface

Interface AdminAccessRoleManagerInterface

Direct known implementers

AdminAccessRoleManager

Package: AdminAccess\Managers
Category: System
Located at Services/System/AdminAccess/Managers/Interfaces/AdminAccessRoleManagerInterface.inc.php

Methods summary

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