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()
¶
FieldValueDiff.php
:
23
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 |
|---|---|---|---|
| $fieldDefinition | FieldDefinition | - | - |
| $comparisonResult | ComparisonResult | - | - |
getComparisonResult()
¶
FieldValueDiff.php
:
31
|
|
|
Return values
getFieldDefinition()
¶
FieldValueDiff.php
:
36
|
|
|
Return values
isChanged()
¶
FieldValueDiff.php
:
41
|
|
|
Return values
bool
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>