Interface AdminAccessGroupManagerInterface

Interface AdminAccessGroupManagerInterface

Direct known implementers

AdminAccessGroupManager

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

Methods summary

`public AdminAccessGroupCollection`	# `getAllGroups( )` Returns all groups as a colleczion. Returns all groups as a colleczion. Returns `AdminAccessGroupCollection` Group collection.
`public AdminAccessGroupInterface`	# `getGroupByController( NonEmptyStringType $identifier )` Returns a group by a given controller identifier. Returns a group by a given controller identifier. Parameters `$identifier` Controller identifier. Returns `AdminAccessGroupInterface` Group object. Throws `GroupNotFoundException`
`public AdminAccessGroupInterface`	# `getGroupByPage( NonEmptyStringType $identifier )` Returns a group by a given page identifier. Returns a group by a given page identifier. Parameters `$identifier` Page identifier. Returns `AdminAccessGroupInterface` Group object. Throws `GroupNotFoundException`
`public AdminAccessGroupInterface`	# `getGroupByAjaxHandler( NonEmptyStringType $identifier )` Returns a group by a given ajax handler identifier. Returns a group by a given ajax handler identifier. Parameters `$identifier` Ajax handler identifier. Returns `AdminAccessGroupInterface` Group object. Throws `GroupNotFoundException`
`public AdminAccessGroupInterface`	# `getGroupById( IdType $id )` Returns a group by a given group id. Returns a group by a given group id. Parameters `$id` Group id. Returns `AdminAccessGroupInterface` Group object. Throws `GroupNotFoundException`
`public AdminAccessGroupInterface`	# `addItemToGroup( IdType $groupId, NonEmptyStringType $identifier, NonEmptyStringType $type )` Adds a group item to an existing group. Adds a group item to an existing group. Parameters `$groupId` Id of the group. `$identifier` Identifier for this item. `$type` Type of this item. Returns `AdminAccessGroupInterface` Group object. Throws `GroupNotFoundException`
`public AdminAccessGroupInterface`	# `removeItemFromGroup( IdType $groupId, NonEmptyStringType $identifier, NonEmptyStringType $type )` Removes a group item from an existing group. Removes a group item from an existing group. Parameters `$groupId` Id of the group. `$identifier` Identifier for this item. `$type` Type of this item. Returns `AdminAccessGroupInterface` Group object. Throws `GroupNotFoundException` `GroupItemNotFoundInCollectionException`
`public AdminAccessGroupInterface`	# `createNewGroup( KeyValueCollection $name, KeyValueCollection $description, IdType $parentId, IntType $sortOrder )` Creates a new group. Creates a new group. Parameters `$name` Collection with the group names. Index of a group name must be his language code. `$description` Collection with the group descriptions. Index of a group name must be his language code. `$parentId` Id of the parent group. `$sortOrder` Group sorts order. Returns `AdminAccessGroupInterface` Returns the create role. Throws `GroupNotFoundException`
`public AdminAccessGroupManager`	# `updateGroup( IdType $id, KeyValueCollection $newName, KeyValueCollection $newDescription, IdType $newParentId, IntType $newSortOrder )` Updates a group by a given group ID. Updates a group by a given group ID. Parameters `$id` $newName Collection with the group names. Index of a group name must be his language code. `$newName` $newDescription Collection with the group descriptions. Index of a group name must be his language code. `$newDescription` $newParentId New id of the parent group. `$newParentId` $newSortOrder New group sorts order. `$newSortOrder` Returns `AdminAccessGroupManager` Returns same instance for chained method calls. Throws `GroupNotFoundException`
`public AdminAccessGroupManager`	# `deleteGroupById( IdType $id )` Deletes a group by a given group ID. Deletes a group by a given group ID. Parameters `$id` ID of the group that should be deleted. Returns `AdminAccessGroupManager` Returns same instance for chained method calls. Throws `GroupNotFoundException`