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()
¶
ContentSuggestion.php
:
27
Construct object optionally with a set of properties.
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$score | float | - | - |
$content | Content | - | - |
$contentType | ContentType | - | - |
$pathString | string | '' | - |
$parentLocations | array<string|int, Location> | [] | - |
getContent()
¶
ContentSuggestion.php
:
41
|
|
Return values
getContentType()
¶
ContentSuggestion.php
:
46
|
|
Return values
getName()
¶
Suggestion.php
:
34
|
|
Return values
string|null
getParentsLocation()
¶
ContentSuggestion.php
:
56
|
|
Return values
getPathString()
¶
ContentSuggestion.php
:
51
|
|
Return values
string
getScore()
¶
Suggestion.php
:
29
|
|
Return values
float
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>