Class AdminAccessGroupManager

AdminAccessGroupManager implements AdminAccessGroupManagerInterface

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

Methods summary


				
				 public 
				
				

				__construct( AdminAccessGroupFactoryInterface $groupFactory, AdminAccessGroupReaderInterface $groupReader )

AdminAccessGroupManager constructor.


				
				 public 
				
				

				getAllGroups( void )
				

				: AdminAccessGroupCollection

Returns all groups as a collection.


				
				 public 
				
				

				getGroupByController( NonEmptyStringType $identifier )
				

				: AdminAccessGroupInterface

Returns a group by a given controller identifier.


				
				 public 
				
				

				getGroupByPage( NonEmptyStringType $identifier )
				

				: AdminAccessGroupInterface

Returns a group by a given page identifier.


				
				 public 
				
				

				getGroupByAjaxHandler( NonEmptyStringType $identifier )
				

				: AdminAccessGroupInterface

Returns a group by a given ajax handler identifier.


				
				 public 
				
				

				getGroupById( IdType $id )
				

				: AdminAccessGroupInterface

Returns a group by a given group id.


				
				 public 
				
				

				addItemToGroup( IdType $groupId, NonEmptyStringType $identifier, NonEmptyStringType $type )
				

				: AdminAccessGroupInterface

Adds a group item to an existing group.


				
				 public 
				
				

				removeItemFromGroup( IdType $groupId, NonEmptyStringType $identifier, NonEmptyStringType $type )
				

				: AdminAccessGroupInterface

Removes a group item from an existing group.


				
				 public 
				
				

				createNewGroup( KeyValueCollection $name, KeyValueCollection $description, IdType $parentId, IntType $sortOrder )
				

				: AdminAccessGroupInterface

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

Implementation of

AdminAccessGroupManagerInterface::createNewGroup()


				
				 public 
				
				

				updateGroup( IdType $id, KeyValueCollection $newName, KeyValueCollection $newDescription, IdType $newParentId, IntType $newSortOrder )
				

				: AdminAccessGroupManager

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

Implementation of

AdminAccessGroupManagerInterface::updateGroup()


				
				 public 
				
				

				deleteGroupById( IdType $id )
				

				: AdminAccessGroupManager

Deletes a group by a given group ID.

Properties summary


				
				protected  
				

				
					$groupFactory
				

				: AdminAccessGroupFactoryInterface


				
				protected  
				

				
					$groupReader
				

				: AdminAccessGroupReaderInterface