The base class for all value objects and structs.
Supports read-only properties by marking them as protected.
In this case they will only be writable using constructor, and need to be documented
using @property-read <type> <$var>
annotation in class doc in addition to inline property doc.
Writable properties must be public and must be documented inline.
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 |
---|---|---|---|
string | - | - | |
$hash | string | - | - |
$createdAt | DateTimeInterface | - | - |
$siteAccessIdentifier | string | - | - |
$used | bool | - | - |
$role | Role|null | null | - |
$userGroup | UserGroup|null | null | - |
$limitation | RoleLimitation|null | null | - |
createdAt()
¶
|
|
Return values
DateTimeInterface
getEmail()
¶
|
|
Return values
string
getHash()
¶
|
|
Return values
string
getLimitation()
¶
|
|
Return values
RoleLimitation|null
getRole()
¶
|
|
Return values
Role|null
getSiteAccessIdentifier()
¶
|
|
Return values
string
getUserGroup()
¶
|
|
Return values
UserGroup|null
isUsed()
¶
|
|
Return values
bool
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>