Class AdminAccessGroup

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

AdminAccessGroup implements AdminAccessGroupInterface

Package: AdminAccess\Entities
Category: System
Located at Services/System/AdminAccess/Entities/AdminAccessGroup.inc.php

Methods summary

`public`	# `__construct( AdminAccessGroupReaderInterface $groupReader, AdminAccessGroupWriterInterface $groupWriter, AdminAccessGroupDeleterInterface $groupDeleter, AdminAccessGroupItemCollection $items )` AdminAccessGroup constructor. AdminAccessGroup constructor. Parameters `$groupReader` `$groupWriter` `$groupDeleter` `$items` Implementation of `AdminAccessGroupInterface::__construct()`
`public integer`	# `getId( )` Returns the group id. Returns the group id. Returns integer Group ID. Implementation of `AdminAccessGroupInterface::getId()`
`public integer`	# `getParentId( )` Returns the group parent id. Returns the group parent id. Returns integer Group parent ID. Implementation of `AdminAccessGroupInterface::getParentId()`
`public KeyValueCollection`	# `getDescription( )` Returns the group descriptions as a collection. Returns the group descriptions as a collection. Returns `KeyValueCollection` Group description in all available languages. Implementation of `AdminAccessGroupInterface::getDescription()`
`public AdminAccessGroupItemCollection`	# `getItems( )` Returns the group items as a collection. Returns the group items as a collection. Returns `AdminAccessGroupItemCollection` Group items. Implementation of `AdminAccessGroupInterface::getItems()`
`public AdminAccessGroupInterface`	# `setId( IdType $id )` Sets the group id. Sets the group id. Parameters `$id` Group ID. Returns `AdminAccessGroupInterface` Returns same instance for chained method calls. Implementation of `AdminAccessGroupInterface::setId()`
`public AdminAccessGroupInterface`	# `setParentGroup( AdminAccessGroupInterface $parentGroup )` Sets the parent group. Sets the parent group. Parameters `$parentGroup` Parent group. Returns `AdminAccessGroupInterface` Returns same instance for chained method calls. Implementation of `AdminAccessGroupInterface::setParentGroup()`
`public KeyValueCollection`	# `getName( )` Returns the group names as a collection. Returns the group names as a collection. Returns `KeyValueCollection` Group name in all available languages. Implementation of `AdminAccessGroupInterface::getName()`
`public AdminAccessGroupInterface`	# `setSortOrder( IntType $sortOrder )` Sets the group sort order. Sets the group sort order. Parameters `$sortOrder` Group sort order. Returns `AdminAccessGroupInterface` Returns same instance for chained method calls. Implementation of `AdminAccessGroupInterface::setSortOrder()`
`public integer`	# `getSortOrder( )` Returns the group sort order. Returns the group sort order. Returns integer Group sort order. Implementation of `AdminAccessGroupInterface::getSortOrder()`
`public AdminAccessGroupInterface`	# `setName( KeyValueCollection $name )` Sets the group names. Sets the group names. Parameters `$name` Group name. Returns `AdminAccessGroupInterface` Returns same instance for chained method calls. Implementation of `AdminAccessGroupInterface::setName()`
`public AdminAccessGroupInterface`	# `setDescription( KeyValueCollection $description )` Sets the group descriptions. Sets the group descriptions. Parameters `$description` Group description. Returns `AdminAccessGroupInterface` Returns same instance for chained method calls. Implementation of `AdminAccessGroupInterface::setDescription()`
`public AdminAccessGroupInterface`	# `setItems( AdminAccessGroupItemCollection $items )` Sets the group items. Sets the group items. Parameters `$items` items. Returns `AdminAccessGroupInterface` Returns same instance for chained method calls. Implementation of `AdminAccessGroupInterface::setItems()`
`public AdminAccessGroupCollection.`	# `getChildren( )` Returns this groups children. Returns this groups children. Returns AdminAccessGroupCollection. Implementation of `AdminAccessGroupInterface::getChildren()`
`public AdminAccessGroupInterface.`	# `getParentGroup( )` Returns this groups parent group. Returns this groups parent group. Returns AdminAccessGroupInterface. Throws `GroupNotFoundException` Implementation of `AdminAccessGroupInterface::getParentGroup()`
`public AdminAccessGroupInterface`	# `addItem( AdminAccessGroupItemInterface $item )` Adds an item to the group. Adds an item to the group. Parameters `$item` Group item. Returns `AdminAccessGroupInterface` Returns same instance for chained method calls. Implementation of `AdminAccessGroupInterface::addItem()`
`public AdminAccessGroupInterface`	# `removeItem( AdminAccessGroupItemInterface $item )` Removes an item from the group. Removes an item from the group. Parameters `$item` Group item. Returns `AdminAccessGroupInterface` Returns same instance for chained method calls. Throws `GroupItemNotFoundInCollectionException` Implementation of `AdminAccessGroupInterface::removeItem()`
`public AdminAccessGroupInterface`	# `delete( )` Deletes an access group. Deletes an access group. Returns `AdminAccessGroupInterface` Returns same instance for chained method calls. Throws `ProtectedGroupException` Implementation of `AdminAccessGroupInterface::delete()`
`public AdminAccessGroupInterface`	# `store( )` Stores this group into the database. Stores this group into the database. Returns `AdminAccessGroupInterface` Returns same instance for chained method calls. Throws `ProtectedGroupException` Implementation of `AdminAccessGroupInterface::store()`
`public AdminAccessGroupInterface`	# `update( )` Updates this group in the database. Updates this group in the database. Returns `AdminAccessGroupInterface` Returns same instance for chained method calls. Throws `ProtectedGroupException` Implementation of `AdminAccessGroupInterface::update()`
`public AdminAccessGroupInterface`	# `setProtected( BoolType $value )` Sets the protected value. Sets the protected value. Parameters `$value` Returns `AdminAccessGroupInterface` Returns same instance for chained method calls. Implementation of `AdminAccessGroupInterface::setProtected()`
`public boolean`	# `getProtected( )` Returns the protected value. Returns the protected value. Returns boolean Implementation of `AdminAccessGroupInterface::getProtected()`

Properties summary

`protected AdminAccessGroupReaderInterface`	`$reader`	#
`protected AdminAccessGroupWriterInterface`	`$writer`	#
`protected AdminAccessGroupDeleterInterface`	`$deleter`	#
`protected integer`	`$id`	#
`protected AdminAccessGroupInterface\|null`	`$parentGroup`	#
`protected KeyValueCollection`	`$name`	#
`protected KeyValueCollection`	`$description`	#
`protected integer`	`$sortOrder`	#
`protected AdminAccessGroupItemCollection`	`$items`	#
`protected boolean`	`$protected`	#

Packages

Classes

Interfaces

Class AdminAccessGroup

Methods summary

Parameters

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Returns

Throws

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Throws

Implementation of

Returns

Throws

Implementation of

Returns

Throws

Implementation of

Returns

Throws

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Properties summary