AdminAccessGroup
in package
implements
AdminAccessGroupInterface
Class AdminAccessGroup
A Group is a collection pages/controllers, that represent a semantic unit for the administration of our shop system.
Tags
Interfaces, Classes and Traits
- AdminAccessGroupInterface
- Interface AdminAccessGroupInterface
Table of Contents
- $deleter : AdminAccessGroupDeleterInterface
- $description : KeyValueCollection
- $id : int
- $items : AdminAccessGroupItemCollection
- $name : KeyValueCollection
- $parentGroup : AdminAccessGroupInterface|null
- $protected : bool
- $reader : AdminAccessGroupReaderInterface
- $sortOrder : int
- $writer : AdminAccessGroupWriterInterface
- __construct() : mixed
- AdminAccessGroup constructor.
- addItem() : AdminAccessGroupInterface
- Adds an item to the group.
- delete() : AdminAccessGroupInterface
- Deletes an access group.
- getChildren() : mixed
- Returns this groups children.
- getDescription() : KeyValueCollection
- Returns the group descriptions as a collection.
- getId() : int
- Returns the group id.
- getItems() : AdminAccessGroupItemCollection
- Returns the group items as a collection.
- getName() : KeyValueCollection
- Returns the group names as a collection.
- getParentGroup() : mixed
- Returns this groups parent group.
- getParentId() : int
- Returns the group parent id.
- getProtected() : bool
- Returns the protected value.
- getSortOrder() : int
- Returns the group sort order.
- removeItem() : AdminAccessGroupInterface
- Removes an item from the group.
- setDescription() : AdminAccessGroupInterface
- Sets the group descriptions.
- setId() : AdminAccessGroupInterface
- Sets the group id.
- setItems() : AdminAccessGroupInterface
- Sets the group items.
- setName() : AdminAccessGroupInterface
- Sets the group names.
- setParentGroup() : AdminAccessGroupInterface
- Sets the parent group.
- setProtected() : AdminAccessGroupInterface
- Sets the protected value.
- setSortOrder() : AdminAccessGroupInterface
- Sets the group sort order.
- store() : AdminAccessGroupInterface
- Stores this group into the database.
- update() : AdminAccessGroupInterface
- Updates this group in the database.
Properties
$deleter
protected
AdminAccessGroupDeleterInterface
$deleter
$description
protected
KeyValueCollection
$description
$id
protected
int
$id
$items
protected
AdminAccessGroupItemCollection
$items
$name
protected
KeyValueCollection
$name
$parentGroup
protected
AdminAccessGroupInterface|null
$parentGroup
$protected
protected
bool
$protected
$reader
protected
AdminAccessGroupReaderInterface
$reader
$sortOrder
protected
int
$sortOrder
$writer
protected
AdminAccessGroupWriterInterface
$writer
Methods
__construct()
AdminAccessGroup constructor.
public
__construct(AdminAccessGroupReaderInterface $groupReader, AdminAccessGroupWriterInterface $groupWriter, AdminAccessGroupDeleterInterface $groupDeleter, AdminAccessGroupItemCollection $items) : mixed
Parameters
- $groupReader : AdminAccessGroupReaderInterface
- $groupWriter : AdminAccessGroupWriterInterface
- $groupDeleter : AdminAccessGroupDeleterInterface
- $items : AdminAccessGroupItemCollection
Return values
mixed —addItem()
Adds an item to the group.
public
addItem(AdminAccessGroupItemInterface $item) : AdminAccessGroupInterface
Parameters
- $item : AdminAccessGroupItemInterface
-
Group item.
Return values
AdminAccessGroupInterface —Returns same instance for chained method calls.
delete()
Deletes an access group.
public
delete() : AdminAccessGroupInterface
Tags
Return values
AdminAccessGroupInterface —Returns same instance for chained method calls.
getChildren()
Returns this groups children.
public
getChildren() : mixed
Return values
mixed —getDescription()
Returns the group descriptions as a collection.
public
getDescription() : KeyValueCollection
Return values
KeyValueCollection —Group description in all available languages.
getId()
Returns the group id.
public
getId() : int
Return values
int —Group ID.
getItems()
Returns the group items as a collection.
public
getItems() : AdminAccessGroupItemCollection
Return values
AdminAccessGroupItemCollection —Group items.
getName()
Returns the group names as a collection.
public
getName() : KeyValueCollection
Return values
KeyValueCollection —Group name in all available languages.
getParentGroup()
Returns this groups parent group.
public
getParentGroup() : mixed
Tags
Return values
mixed —getParentId()
Returns the group parent id.
public
getParentId() : int
Return values
int —Group parent ID.
getProtected()
Returns the protected value.
public
getProtected() : bool
Return values
bool —getSortOrder()
Returns the group sort order.
public
getSortOrder() : int
Return values
int —Group sort order.
removeItem()
Removes an item from the group.
public
removeItem(AdminAccessGroupItemInterface $item) : AdminAccessGroupInterface
Parameters
- $item : AdminAccessGroupItemInterface
-
Group item.
Tags
Return values
AdminAccessGroupInterface —Returns same instance for chained method calls.
setDescription()
Sets the group descriptions.
public
setDescription(KeyValueCollection $description) : AdminAccessGroupInterface
Parameters
- $description : KeyValueCollection
-
Group description.
Return values
AdminAccessGroupInterface —Returns same instance for chained method calls.
setId()
Sets the group id.
public
setId(IdType $id) : AdminAccessGroupInterface
Parameters
- $id : IdType
-
Group ID.
Return values
AdminAccessGroupInterface —Returns same instance for chained method calls.
setItems()
Sets the group items.
public
setItems(AdminAccessGroupItemCollection $items) : AdminAccessGroupInterface
Parameters
- $items : AdminAccessGroupItemCollection
Return values
AdminAccessGroupInterface —Returns same instance for chained method calls.
setName()
Sets the group names.
public
setName(KeyValueCollection $name) : AdminAccessGroupInterface
Parameters
- $name : KeyValueCollection
-
Group name.
Return values
AdminAccessGroupInterface —Returns same instance for chained method calls.
setParentGroup()
Sets the parent group.
public
setParentGroup(AdminAccessGroupInterface|null $parentGroup) : AdminAccessGroupInterface
Parameters
- $parentGroup : AdminAccessGroupInterface|null
-
Parent group.
Return values
AdminAccessGroupInterface —Returns same instance for chained method calls.
setProtected()
Sets the protected value.
public
setProtected(BoolType $value) : AdminAccessGroupInterface
Parameters
- $value : BoolType
Return values
AdminAccessGroupInterface —Returns same instance for chained method calls.
setSortOrder()
Sets the group sort order.
public
setSortOrder(IntType $sortOrder) : AdminAccessGroupInterface
Parameters
- $sortOrder : IntType
-
Group sort order.
Return values
AdminAccessGroupInterface —Returns same instance for chained method calls.
store()
Stores this group into the database.
public
store() : AdminAccessGroupInterface
Tags
Return values
AdminAccessGroupInterface —Returns same instance for chained method calls.
update()
Updates this group in the database.
public
update() : AdminAccessGroupInterface
Tags
Return values
AdminAccessGroupInterface —Returns same instance for chained method calls.