This class represents a role.
Constants¶
STATUS_DEFINED ¶
Role.php
:
23
|
|
|
Status constant for defined (aka "published") role
STATUS_DRAFT ¶
Role.php
:
26
|
|
|
Status constant for draft (aka "temporary") role
Properties¶
$policies
¶
Role.php
|
|
|
an array of the policies Policy of the role.
$id
¶
Role.php
:
33
ID of the user role.
|
|
|
$identifier
¶
Role.php
:
41
Readable string identifier of a role in 4.x. this is mapped to the role name.
|
|
|
$status
¶
Role.php
:
48
The status of the role.
|
|
|
One of Role::STATUS_DEFINED|Role::STATUS_DRAFT
Methods¶
__construct()
¶
ValueObject.php
:
31
Construct object optionally with a set of properties.
|
|
|
Readonly properties values must be set using $properties as they aren't writable anymore
after object has been created.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $properties | array<string, mixed> | [] | - |
getPolicies()
¶
Role.php
:
60
Returns the list of policies of this role.
|
|
|
Return values
array<string|int, Policy>
getStatus()
¶
Role.php
:
50
|
|
|
Return values
int
getProperties()
¶
ValueObject.php
:
54
Returns list of available properties' names.
|
|
|
Override to add dynamic properties.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $dynamicProperties | array<int, string> | [] |
Additional dynamic properties exposed on the object |
Return values
array<int, string>