Base SPI Value object.
All properties of SPI\ValueObject must be serializable for cache & NoSQL use.
Constants¶
STATUS_DEFINED ¶
|
|
|
Status constant for defined (aka "published") role
STATUS_DRAFT ¶
|
|
|
Status constant for draft (aka "temporary") role
Properties¶
$description
¶
Name of the role.
|
|
|
$id
¶
ID of the user rule.
|
|
|
$identifier
¶
Identifier of the role.
|
|
|
Legacy note: Maps to name in 4.x.
$name
¶
Name of the role.
|
|
|
$originalId
¶
Only used when the role's status, is Role::STATUS_DRAFT.
|
|
|
Original role ID the draft was created from, or -1 if it's a new role. Will be null if role's status is Role::STATUS_DEFINED.
$policies
¶
Policies associated with the role.
|
|
|
$status
¶
Status of the role (legacy: "version").
|
|
|
One of Role::STATUS_DEFINED|Role::STATUS_DRAFT
Methods¶
__construct()
¶
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> | [] | - |
getProperties()
¶
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>