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()
¶
SessionUpdateStruct.php
:
27
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 |
---|---|---|---|
$sessionUpdateStruct | AbstractSessionUpdateStruct | - | - |
$token | string|null | - | - |
$owner | UserReference|null | - | - |
$isActive | bool|null | - | - |
$hasPublicLink | bool|null | - | - |
getOwner()
¶
SessionUpdateStruct.php
:
53
|
|
Return values
UserReference|null
getSessionUpdateStruct()
¶
SessionUpdateStruct.php
:
43
|
|
Return values
getToken()
¶
SessionUpdateStruct.php
:
48
|
|
Return values
string|null
hasPublicLink()
¶
SessionUpdateStruct.php
:
63
|
|
Return values
bool|null
isActive()
¶
SessionUpdateStruct.php
:
58
|
|
Return values
bool|null
getProperties()
¶
ValueObject.php
:
53
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>
Attributes
- #[Ignore]