Interface AdminAccessGroupInterface

Direct known implementers

AdminAccessGroup

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

Methods summary

`public`	# `__construct( AdminAccessGroupReaderInterface $groupReader, AdminAccessGroupWriterInterface $groupWriter, AdminAccessGroupDeleterInterface $groupDeleter, AdminAccessGroupItemCollection $items )` AdminAccessGroup constructor. AdminAccessGroup constructor. Parameters `$groupReader` `$groupWriter` `$groupDeleter` `$items`
`public integer`	# `getId( )` Returns the group id. Returns the group id. Returns integer Group ID.
`public integer`	# `getParentId( )` Returns the group parent id. Returns the group parent id. Returns integer Group parent ID.
`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.
`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.
`public AdminAccessGroupItemCollection`	# `getItems( )` Returns the group items as a collection. Returns the group items as a collection. Returns `AdminAccessGroupItemCollection` Group items.
`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.
`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.
`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.
`public integer`	# `getSortOrder( )` Returns the group sort order. Returns the group sort order. Returns integer Group sort order.
`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.
`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.
`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.
`public AdminAccessGroupCollection.`	# `getChildren( )` Returns this groups children. Returns this groups children. Returns AdminAccessGroupCollection.
`public AdminAccessGroupInterface.`	# `getParentGroup( )` Returns this groups parent group. Returns this groups parent group. Returns AdminAccessGroupInterface. Throws `GroupNotFoundException`
`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.
`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`
`public AdminAccessGroupInterface`	# `delete( )` Deletes an access group. Deletes an access group. Returns `AdminAccessGroupInterface` Returns same instance for chained method calls.
`public AdminAccessGroupInterface`	# `store( )` Stores this group into the database. Stores this group into the database. Returns `AdminAccessGroupInterface` Returns same instance for chained method calls.
`public AdminAccessGroupInterface`	# `update( )` Updates this group in the database. Updates this group in the database. Returns `AdminAccessGroupInterface` Returns same instance for chained method calls.
`public AdminAccessGroupInterface`	# `setProtected( BoolType $value )` Sets the protected value. Sets the protected value. Parameters `$value` Returns `AdminAccessGroupInterface` Returns same instance for chained method calls.
`public boolean`	# `getProtected( )` Returns the protected value. Returns the protected value. Returns boolean

Packages

Classes

Interfaces

Interface AdminAccessGroupInterface

Direct known implementers

Methods summary

Parameters

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Throws

Parameters

Returns

Parameters

Returns

Throws

Returns

Returns

Returns

Parameters

Returns

Returns