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()
¶
InvitationCreateStruct.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 |
|---|---|---|---|
| $session | SessionInterface | - | - |
| $participant | ParticipantInterface | - | - |
getContext()
¶
InvitationCreateStruct.php
:
58
|
|
|
Return values
array<string, mixed>
getParticipant()
¶
InvitationCreateStruct.php
:
40
|
|
|
Return values
getSender()
¶
InvitationCreateStruct.php
:
45
|
|
|
Return values
UserReference|null
getSession()
¶
InvitationCreateStruct.php
:
35
|
|
|
Return values
setContext()
¶
InvitationCreateStruct.php
:
66
|
|
|
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $context | array<string, mixed> | - | - |
setSender()
¶
InvitationCreateStruct.php
:
50
|
|
|
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $sender | UserReference | - | - |
getProperties()
¶
ValueObject.php
:
54
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>