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()
¶
OrderUpdateStruct.php
:
29
Construct object optionally with a set of properties.
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$status | string | - | - |
$transition | string|null | null | - |
$owner | UserReference|null | null | - |
$context | MapInterface<string, mixed>|null | null | - |
getContext()
¶
OrderUpdateStruct.php
:
74
|
|
Return values
MapInterface<string, mixed>|null
getOwner()
¶
OrderUpdateStruct.php
:
53
|
|
Return values
UserReference|null
getStatus()
¶
OrderUpdateStruct.php
:
43
|
|
Return values
string
getTransition()
¶
OrderUpdateStruct.php
:
48
|
|
Return values
string|null
setContext()
¶
OrderUpdateStruct.php
:
66
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$context | MapInterface<string, mixed>|null | - | - |
setOwner()
¶
OrderUpdateStruct.php
:
58
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$owner | UserReference|null | - | - |
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>