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.
Constants¶
STATUS_ONLINE ¶
Page.php
:
16
|
|
|
Properties¶
$languages
¶
Page.php
:
25
|
|
|
$name
¶
Page.php
:
22
|
|
|
$status
¶
Page.php
:
19
|
|
|
$treeRootLocation
¶
Page.php
:
28
|
|
|
Methods¶
__construct()
¶
Page.php
:
33
Construct object optionally with a set of properties.
|
|
|
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $name | string | - | - |
| $languages | array<string|int, string> | - | - |
| $treeRootLocation | Location|null | - | - |
getLanguages()
¶
Page.php
:
57
|
|
|
Return values
array<string|int, string>
getName()
¶
Page.php
:
49
|
|
|
Return values
string
getStatus()
¶
Page.php
:
44
|
|
|
Return values
int
getTreeRootLocation()
¶
Page.php
:
65
Tree root Location will be empty when user does not have permission to load it.
|
|
|
Return values
Location|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>