AdminAccessGroupManagerInterface

Extends

Interface AdminAccessGroupManagerInterface

category

System

package

AdminAccess

subpackage

Managers

Methods

Adds a group item to an existing group.

addItemToGroup(\IdType $groupId, \NonEmptyStringType $identifier, \NonEmptyStringType $type) : \AdminAccessGroupInterface
Throws
\GroupNotFoundException

Arguments

$groupId

\IdType

Id of the group.

$identifier

\NonEmptyStringType

Identifier for this item.

$type

\NonEmptyStringType

Type of this item.

Response

\AdminAccessGroupInterface

Group object.

Creates a new group.

createNewGroup(\KeyValueCollection $name, \KeyValueCollection $description, \IdType $parentId, \IntType $sortOrder) : \AdminAccessGroupInterface
Throws
\GroupNotFoundException

Arguments

$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.

Response

\AdminAccessGroupInterface

Returns the create role.

Deletes a group by a given group ID.

deleteGroupById(\IdType $id) : \AdminAccessGroupManager
Throws
\GroupNotFoundException

Arguments

$id

\IdType

ID of the group that should be deleted.

Response

\AdminAccessGroupManager

Returns same instance for chained method calls.

Returns all groups as a colleczion.

getAllGroups() : \AdminAccessGroupCollection

Response

\AdminAccessGroupCollection

Group collection.

Returns a group by a given ajax handler identifier.

getGroupByAjaxHandler(\NonEmptyStringType $identifier) : \AdminAccessGroupInterface
Throws
\GroupNotFoundException

Arguments

$identifier

\NonEmptyStringType

Ajax handler identifier.

Response

\AdminAccessGroupInterface

Group object.

Returns a group by a given controller identifier.

getGroupByController(\NonEmptyStringType $identifier) : \AdminAccessGroupInterface
Throws
\GroupNotFoundException

Arguments

$identifier

\NonEmptyStringType

Controller identifier.

Response

\AdminAccessGroupInterface

Group object.

Returns a group by a given group id.

getGroupById(\IdType $id) : \AdminAccessGroupInterface
Throws
\GroupNotFoundException

Arguments

$id

\IdType

Group id.

Response

\AdminAccessGroupInterface

Group object.

Returns a group by a given page identifier.

getGroupByPage(\NonEmptyStringType $identifier) : \AdminAccessGroupInterface
Throws
\GroupNotFoundException

Arguments

$identifier

\NonEmptyStringType

Page identifier.

Response

\AdminAccessGroupInterface

Group object.

Removes a group item from an existing group.

removeItemFromGroup(\IdType $groupId, \NonEmptyStringType $identifier, \NonEmptyStringType $type) : \AdminAccessGroupInterface
Throws
\GroupNotFoundException
\GroupItemNotFoundInCollectionException

Arguments

$groupId

\IdType

Id of the group.

$identifier

\NonEmptyStringType

Identifier for this item.

$type

\NonEmptyStringType

Type of this item.

Response

\AdminAccessGroupInterface

Group object.

Updates a group by a given group ID.

updateGroup(\IdType $id, \KeyValueCollection $newName, \KeyValueCollection $newDescription, \IdType $newParentId, \IntType $newSortOrder) : \AdminAccessGroupManager
Throws
\GroupNotFoundException

Arguments

$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.

Response

\AdminAccessGroupManager

Returns same instance for chained method calls.