API Documentation
Back to top  

AdminAccessGroup

Implements \AdminAccessGroupInterface

Class AdminAccessGroup

A Group is a collection pages/controllers, that represent a semantic unit for the administration of our shop system.

category

System
package

AdminAccess
subpackage

Entities

Methods

AdminAccessGroup constructor.

__construct(\AdminAccessGroupReaderInterface $groupReader, \AdminAccessGroupWriterInterface $groupWriter, \AdminAccessGroupDeleterInterface $groupDeleter, \AdminAccessGroupItemCollection $items)

Arguments

$groupReader

\AdminAccessGroupReaderInterface

$groupWriter

\AdminAccessGroupWriterInterface

$groupDeleter

\AdminAccessGroupDeleterInterface

$items

\AdminAccessGroupItemCollection

Adds an item to the group.

addItem(\AdminAccessGroupItemInterface $item) : \AdminAccessGroupInterface

Arguments

$item

\AdminAccessGroupItemInterface

Group item.

Response

\AdminAccessGroupInterface

Returns same instance for chained method calls.

Deletes an access group.

delete() : \AdminAccessGroupInterface
Throws
\ProtectedGroupException

Response

\AdminAccessGroupInterface

Returns same instance for chained method calls.

Returns this groups children.

getChildren() : \AdminAccessGroupCollection.

Response

\AdminAccessGroupCollection.

Returns the group descriptions as a collection.

getDescription() : \KeyValueCollection

Response

\KeyValueCollection

Group description in all available languages.

Returns the group id.

getId() : integer

Response

integer

Group ID.

Returns the group items as a collection.

getItems() : \AdminAccessGroupItemCollection

Response

\AdminAccessGroupItemCollection

Group items.

Returns the group names as a collection.

getName() : \KeyValueCollection

Response

\KeyValueCollection

Group name in all available languages.

Returns this groups parent group.

getParentGroup() : \AdminAccessGroupInterface.
Throws
\GroupNotFoundException

Response

\AdminAccessGroupInterface.

Returns the group parent id.

getParentId() : integer

Response

integer

Group parent ID.

Returns the protected value.

getProtected() : boolean

Response

boolean

Returns the group sort order.

getSortOrder() : integer

Response

integer

Group sort order.

Removes an item from the group.

removeItem(\AdminAccessGroupItemInterface $item) : \AdminAccessGroupInterface
Throws
\GroupItemNotFoundInCollectionException

Arguments

$item

\AdminAccessGroupItemInterface

Group item.

Response

\AdminAccessGroupInterface

Returns same instance for chained method calls.

Sets the group descriptions.

setDescription(\KeyValueCollection $description) : \AdminAccessGroupInterface

Arguments

$description

\KeyValueCollection

Group description.

Response

\AdminAccessGroupInterface

Returns same instance for chained method calls.

Sets the group id.

setId(\IdType $id) : \AdminAccessGroupInterface

Arguments

$id

\IdType

Group ID.

Response

\AdminAccessGroupInterface

Returns same instance for chained method calls.

Sets the group items.

setItems(\AdminAccessGroupItemCollection $items) : \AdminAccessGroupInterface

Arguments

$items

\AdminAccessGroupItemCollection

Response

\AdminAccessGroupInterface

Returns same instance for chained method calls.

Sets the group names.

setName(\KeyValueCollection $name) : \AdminAccessGroupInterface

Arguments

$name

\KeyValueCollection

Group name.

Response

\AdminAccessGroupInterface

Returns same instance for chained method calls.

Sets the parent group.

setParentGroup(\AdminAccessGroupInterface $parentGroup) : \AdminAccessGroupInterface

Arguments

$parentGroup

\AdminAccessGroupInterface

Parent group.

Response

\AdminAccessGroupInterface

Returns same instance for chained method calls.

Sets the protected value.

setProtected(\BoolType $value) : \AdminAccessGroupInterface

Arguments

$value

\BoolType

Response

\AdminAccessGroupInterface

Returns same instance for chained method calls.

Sets the group sort order.

setSortOrder(\IntType $sortOrder) : \AdminAccessGroupInterface

Arguments

$sortOrder

\IntType

Group sort order.

Response

\AdminAccessGroupInterface

Returns same instance for chained method calls.

Stores this group into the database.

store() : \AdminAccessGroupInterface
Throws
\ProtectedGroupException

Response

\AdminAccessGroupInterface

Returns same instance for chained method calls.

Updates this group in the database.

update() : \AdminAccessGroupInterface
Throws
\ProtectedGroupException

Response

\AdminAccessGroupInterface

Returns same instance for chained method calls.

Properties

reader

reader : \AdminAccessGroupReaderInterface
var

Type(s)

\AdminAccessGroupReaderInterface

writer

writer : \AdminAccessGroupWriterInterface
var

Type(s)

\AdminAccessGroupWriterInterface

deleter

deleter : \AdminAccessGroupDeleterInterface
var

Type(s)

\AdminAccessGroupDeleterInterface

id

id : integer
var

Type(s)

integer

parentGroup

parentGroup : \AdminAccessGroupInterface|null
var

Type(s)

\AdminAccessGroupInterface|null

name

name : \KeyValueCollection
var

Type(s)

\KeyValueCollection

description

description : \KeyValueCollection
var

Type(s)

\KeyValueCollection

sortOrder

sortOrder : integer
var

Type(s)

integer

items

items : \AdminAccessGroupItemCollection
var

Type(s)

\AdminAccessGroupItemCollection

protected

protected : boolean
var

Type(s)

boolean