AccessRole
extends AbstractEventRaisingEntity
in package
Class AccessRole
Table of Contents
- $descriptions : AccessRoleDescriptions
- $id : AccessRoleId
- $isProtected : bool
- $names : AccessRoleNames
- $permissions : Permissions
- $raisedEvents : array<string|int, object>
- $sortOrder : int
- checkPermission() : bool
- create() : AccessRole
- description() : string
- id() : int
- isProtected() : bool
- name() : string
- permissions() : Permissions
- releaseEvents() : array<string|int, object>
- sortOrder() : int
- updateNamesAndDescriptions() : void
- updatePermission() : void
- updateSortOrder() : void
- raiseEvent() : void
- __construct() : mixed
- AccessRole constructor.
Properties
$descriptions
private
AccessRoleDescriptions
$descriptions
$id
private
AccessRoleId
$id
$isProtected
private
bool
$isProtected
$names
private
AccessRoleNames
$names
$permissions
private
Permissions
$permissions
$raisedEvents
private
array<string|int, object>
$raisedEvents
= []
$sortOrder
private
int
$sortOrder
Methods
checkPermission()
public
checkPermission(PermissionAction $action, GroupId $groupId) : bool
Parameters
- $action : PermissionAction
- $groupId : GroupId
Return values
bool —create()
public
static create(AccessRoleId $id, AccessRoleNames $names, AccessRoleDescriptions $descriptions, Permissions $permissions, int $sortOrder, bool $isProtected) : AccessRole
Parameters
- $id : AccessRoleId
- $names : AccessRoleNames
- $descriptions : AccessRoleDescriptions
- $permissions : Permissions
- $sortOrder : int
- $isProtected : bool
Return values
AccessRole —description()
public
description(string $languageCode) : string
Parameters
- $languageCode : string
Return values
string —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 —permissions()
public
permissions() : Permissions
Return values
Permissions —releaseEvents()
public
releaseEvents() : array<string|int, object>
Return values
array<string|int, object> —sortOrder()
public
sortOrder() : int
Return values
int —updateNamesAndDescriptions()
public
updateNamesAndDescriptions(AccessRoleNames $names, AccessRoleDescriptions $descriptions) : void
Parameters
- $names : AccessRoleNames
- $descriptions : AccessRoleDescriptions
Return values
void —updatePermission()
public
updatePermission(Permission $permission) : void
Parameters
- $permission : Permission
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()
AccessRole constructor.
private
__construct(AccessRoleId $id, AccessRoleNames $names, AccessRoleDescriptions $descriptions, Permissions $permissions, int $sortOrder, bool $isProtected) : mixed
Parameters
- $id : AccessRoleId
- $names : AccessRoleNames
- $descriptions : AccessRoleDescriptions
- $permissions : Permissions
- $sortOrder : int
- $isProtected : bool