Role

Role.php : 11 Copy path

Extends ValueObject

Base SPI Value object.

All properties of SPI\ValueObject must be serializable for cache & NoSQL use.

Constants¶

STATUS_DEFINED ¶

Role.php : 14 Copy path

public int STATUS_DEFINED = 0

Status constant for defined (aka "published") role

STATUS_DRAFT ¶

Role.php : 17 Copy path

public int STATUS_DRAFT = 1

Status constant for draft (aka "temporary") role

Properties¶

$description ¶

Role.php : 71 Copy path

Name of the role.

public array<string|int, string> $description = []

$id ¶

Role.php : 24 Copy path

ID of the user rule.

public mixed $id

$identifier ¶

Role.php : 44 Copy path

Identifier of the role.

public string $identifier

Legacy note: Maps to name in 4.x.

$name ¶

Role.php : 62 Copy path

Name of the role.

public array<string|int, string> $name

$originalId ¶

Role.php : 35 Copy path

Only used when the role's status, is Role::STATUS_DRAFT.

public int|null $originalId

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 ¶

Role.php : 78 Copy path

Policies associated with the role.

public array<string|int, Policy> $policies = []

$status ¶

Role.php : 53 Copy path

Status of the role (legacy: "version").

public int $status

One of Role::STATUS_DEFINED|Role::STATUS_DRAFT

Methods¶

__construct() ¶

ValueObject.php : 30 Copy path

Construct object optionally with a set of properties.

public __construct([array<string|int, mixed> $properties = [] ])

Readonly properties values must be set using $properties as they are not writable anymore after object has been created.

Parameters

Name	Type	Default value	Description
$properties	array<string\|int, mixed>	[]	-

getProperties() ¶

ValueObject.php : 50 Copy path

Function where list of properties are returned.

    
                        protected getProperties([array<string|int, mixed> $dynamicProperties = [] ]) : array<string|int, mixed>

Used by attributes(), override to add dynamic properties

Parameters

Name	Type	Default value	Description
$dynamicProperties	array<string\|int, mixed>	[]	Additional dynamic properties exposed on the object

Return values

array<string|int, mixed>