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.
Properties¶
$value
¶
FieldData.php
:
21
|
|
|
$field
¶
FieldData.php
:
17
|
|
|
$fieldDefinition
¶
FieldData.php
:
19
|
|
|
Methods¶
__construct()
¶
ValueObject.php
:
32
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 |
|---|---|---|---|
| $properties | array<string, mixed> | [] | - |
getField()
¶
FieldData.php
:
23
|
|
|
Return values
getFieldDefinition()
¶
FieldData.php
:
28
|
|
|
Return values
getFieldTypeIdentifier()
¶
FieldData.php
:
38
|
|
|
Return values
string
getValue()
¶
FieldData.php
:
33
|
|
|
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]