AdminAccessGroupManager
in package
implements
AdminAccessGroupManagerInterface
Class AdminAccessGroupManager
Tags
Interfaces, Classes and Traits
- AdminAccessGroupManagerInterface
- Interface AdminAccessGroupManagerInterface
Table of Contents
- $groupFactory : AdminAccessGroupFactoryInterface
- $groupReader : AdminAccessGroupReaderInterface
- __construct() : mixed
- AdminAccessGroupManager constructor.
- addItemToGroup() : AdminAccessGroupInterface
- Adds a group item to an existing group.
- createNewGroup() : AdminAccessGroupInterface
- Creates a new group.
- deleteGroupById() : AdminAccessGroupManager
- Deletes a group by a given group ID.
- getAllGroups() : AdminAccessGroupCollection
- Returns all groups as a collection.
- getGroupByAjaxHandler() : AdminAccessGroupInterface
- Returns a group by a given ajax handler identifier.
- getGroupByController() : AdminAccessGroupInterface
- Returns a group by a given controller identifier.
- getGroupById() : AdminAccessGroupInterface
- Returns a group by a given group id.
- getGroupByPage() : AdminAccessGroupInterface
- Returns a group by a given page identifier.
- removeItemFromGroup() : AdminAccessGroupInterface
- Removes a group item from an existing group.
- updateGroup() : AdminAccessGroupManager
- Updates a group by a given group ID.
Properties
$groupFactory
protected
AdminAccessGroupFactoryInterface
$groupFactory
$groupReader
protected
AdminAccessGroupReaderInterface
$groupReader
Methods
__construct()
AdminAccessGroupManager constructor.
public
__construct(AdminAccessGroupFactoryInterface $groupFactory, AdminAccessGroupReaderInterface $groupReader) : mixed
Parameters
- $groupFactory : AdminAccessGroupFactoryInterface
-
Group factory.
- $groupReader : AdminAccessGroupReaderInterface
-
Group reader.
Return values
mixed —addItemToGroup()
Adds a group item to an existing group.
public
addItemToGroup(IdType $groupId, NonEmptyStringType $identifier, NonEmptyStringType $type) : AdminAccessGroupInterface
Parameters
- $groupId : IdType
-
Id of the group.
- $identifier : NonEmptyStringType
-
Identifier for this item.
- $type : NonEmptyStringType
-
Type of this item.
Tags
Return values
AdminAccessGroupInterface —Group object.
createNewGroup()
Creates a new group.
public
createNewGroup(KeyValueCollection $name, KeyValueCollection $description, IdType $parentId, IntType $sortOrder) : AdminAccessGroupInterface
Parameters
- $name : KeyValueCollection
-
Collection with the group names. Index of a group name must be his language code.
- $description : KeyValueCollection
-
Collection with the group descriptions. Index of a group name must be his language code.
- $parentId : IdType
-
Id of the parent group.
- $sortOrder : IntType
-
Group sorts order.
Tags
Return values
AdminAccessGroupInterface —Returns the create role.
deleteGroupById()
Deletes a group by a given group ID.
public
deleteGroupById(IdType $id) : AdminAccessGroupManager
Parameters
- $id : IdType
-
ID of the group that should be deleted.
Tags
Return values
AdminAccessGroupManager —Returns same instance for chained method calls.
getAllGroups()
Returns all groups as a collection.
public
getAllGroups() : AdminAccessGroupCollection
Return values
AdminAccessGroupCollection —Group collection.
getGroupByAjaxHandler()
Returns a group by a given ajax handler identifier.
public
getGroupByAjaxHandler(NonEmptyStringType $identifier) : AdminAccessGroupInterface
Parameters
- $identifier : NonEmptyStringType
-
Ajax handler identifier.
Tags
Return values
AdminAccessGroupInterface —Group object.
getGroupByController()
Returns a group by a given controller identifier.
public
getGroupByController(NonEmptyStringType $identifier) : AdminAccessGroupInterface
Parameters
- $identifier : NonEmptyStringType
-
Controller identifier.
Tags
Return values
AdminAccessGroupInterface —Group object.
getGroupById()
Returns a group by a given group id.
public
getGroupById(IdType $id) : AdminAccessGroupInterface
Parameters
- $id : IdType
-
Group id.
Tags
Return values
AdminAccessGroupInterface —Group object.
getGroupByPage()
Returns a group by a given page identifier.
public
getGroupByPage(NonEmptyStringType $identifier) : AdminAccessGroupInterface
Parameters
- $identifier : NonEmptyStringType
-
Page identifier.
Tags
Return values
AdminAccessGroupInterface —Group object.
removeItemFromGroup()
Removes a group item from an existing group.
public
removeItemFromGroup(IdType $groupId, NonEmptyStringType $identifier, NonEmptyStringType $type) : AdminAccessGroupInterface
Parameters
- $groupId : IdType
-
Id of the group.
- $identifier : NonEmptyStringType
-
Identifier for this item.
- $type : NonEmptyStringType
-
Type of this item.
Tags
Return values
AdminAccessGroupInterface —Group object.
updateGroup()
Updates a group by a given group ID.
public
updateGroup(IdType $id, KeyValueCollection $newName, KeyValueCollection $newDescription, IdType $newParentId, IntType $newSortOrder) : AdminAccessGroupManager
Parameters
- $id : IdType
- $newName : KeyValueCollection
-
Collection with the group names. Index of a group name must be his language code.
- $newDescription : KeyValueCollection
-
Collection with the group descriptions. Index of a group name must be his language code.
- $newParentId : IdType
-
New id of the parent group.
- $newSortOrder : IntType
-
New group sorts order.
Tags
Return values
AdminAccessGroupManager —Returns same instance for chained method calls.