Role

Role.php : 20 Copy path

Extends ValueObject

This class represents a role.

Constants¶

STATUS_DEFINED ¶

Role.php : 23 Copy path

public int STATUS_DEFINED = 0

Status constant for defined (aka "published") role

STATUS_DRAFT ¶

Role.php : 26 Copy path

public int STATUS_DRAFT = 1

Status constant for draft (aka "temporary") role

Properties¶

$id read-only ¶

Role.php

public int $id

the internal id of the role

$identifier read-only ¶

Role.php

public string $identifier

the identifier of the role

$policies read-only ¶

Role.php

public array<string|int, Policy> $policies

an array of the policies Policy of the role.

$id ¶

Role.php : 33 Copy path

ID of the user role.

protected int $id

$identifier ¶

Role.php : 41 Copy path

Readable string identifier of a role in 4.x. this is mapped to the role name.

protected string $identifier

$status ¶

Role.php : 48 Copy path

The status of the role.

protected 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>	[]	-

getPolicies() ¶

Role.php : 60 Copy path

Returns the list of policies of this role.

public abstract getPolicies() : array<string|int, Policy>

Return values

array<string|int, Policy>

getStatus() ¶

Role.php : 50 Copy path

public getStatus() : int

Return values

int

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>