AccessGroup
extends AbstractEventRaisingEntity
in package
Class AccessGroup
Table of Contents
- $descriptions : AccessGroupDescriptions
- $id : AccessGroupId
- $isProtected : bool
- $items : AccessGroupItems
- $names : AccessGroupNames
- $parent : ParentAccessGroupId|null
- $raisedEvents : array<string|int, object>
- $sortOrder : int
- addItem() : void
- createWithoutParent() : AccessGroup
- createWithParent() : AccessGroup
- description() : string
- groupItems() : AccessGroupItems
- id() : int
- isProtected() : bool
- name() : string
- parentGroupId() : int
- releaseEvents() : array<string|int, object>
- removeItem() : void
- sortOrder() : int
- updateNamesAndDescriptions() : void
- updateSortOrder() : void
- raiseEvent() : void
- __construct() : mixed
- AccessGroup constructor.
Properties
$descriptions
private
AccessGroupDescriptions
$descriptions
$id
private
AccessGroupId
$id
$isProtected
private
bool
$isProtected
$items
private
AccessGroupItems
$items
$names
private
AccessGroupNames
$names
$parent
private
ParentAccessGroupId|null
$parent
$raisedEvents
private
array<string|int, object>
$raisedEvents
= []
$sortOrder
private
int
$sortOrder
Methods
addItem()
public
addItem(AccessGroupItem $groupItem) : void
Parameters
- $groupItem : AccessGroupItem
Return values
void —createWithoutParent()
public
static createWithoutParent(AccessGroupId $id, AccessGroupNames $names, AccessGroupDescriptions $descriptions, AccessGroupItems $items, int $sortOrder, bool $isProtected) : AccessGroup
Parameters
- $id : AccessGroupId
- $names : AccessGroupNames
- $descriptions : AccessGroupDescriptions
- $items : AccessGroupItems
- $sortOrder : int
- $isProtected : bool
Return values
AccessGroup —createWithParent()
public
static createWithParent(AccessGroupId $id, ParentAccessGroupId $parent, AccessGroupNames $names, AccessGroupDescriptions $descriptions, AccessGroupItems $items, int $sortOrder, bool $isProtected) : AccessGroup
Parameters
- $id : AccessGroupId
- $parent : ParentAccessGroupId
- $names : AccessGroupNames
- $descriptions : AccessGroupDescriptions
- $items : AccessGroupItems
- $sortOrder : int
- $isProtected : bool
Return values
AccessGroup —description()
public
description(string $languageCode) : string
Parameters
- $languageCode : string
Return values
string —groupItems()
public
groupItems() : AccessGroupItems
Return values
AccessGroupItems —id()
public
id() : int
Return values
int —isProtected()
public
isProtected() : bool
Return values
bool —name()
public
name(string $languageCode) : string
Parameters
- $languageCode : string
Return values
string —parentGroupId()
public
parentGroupId() : int
Tags
Return values
int —releaseEvents()
public
releaseEvents() : array<string|int, object>
Return values
array<string|int, object> —removeItem()
public
removeItem(AccessGroupItem $groupItem) : void
Parameters
- $groupItem : AccessGroupItem
Return values
void —sortOrder()
public
sortOrder() : int
Return values
int —updateNamesAndDescriptions()
public
updateNamesAndDescriptions(AccessGroupNames $names, AccessGroupDescriptions $descriptions) : void
Parameters
- $names : AccessGroupNames
- $descriptions : AccessGroupDescriptions
Return values
void —updateSortOrder()
public
updateSortOrder(int $sortOrder) : void
Parameters
- $sortOrder : int
Return values
void —raiseEvent()
protected
raiseEvent(object $event) : void
Parameters
- $event : object
Return values
void —__construct()
AccessGroup constructor.
private
__construct(AccessGroupId $id, ParentAccessGroupId|null $parent, AccessGroupNames $names, AccessGroupDescriptions $descriptions, AccessGroupItems $items, int $sortOrder, bool $isProtected) : mixed
Parameters
- $id : AccessGroupId
- $parent : ParentAccessGroupId|null
- $names : AccessGroupNames
- $descriptions : AccessGroupDescriptions
- $items : AccessGroupItems
- $sortOrder : int
- $isProtected : bool