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_OFFLINE ¶
Site.php
:
15
|
|
|
STATUS_ONLINE ¶
Site.php
:
16
|
|
|
Properties¶
$created
¶
Site.php
:
31
|
|
|
$id
¶
Site.php
:
19
|
|
|
$languages
¶
Site.php
:
34
|
|
|
$name
¶
Site.php
:
28
|
|
|
$publicAccesses
¶
Site.php
:
25
|
|
|
$status
¶
Site.php
:
22
|
|
|
$template
¶
Site.php
:
37
|
|
|
Methods¶
__construct()
¶
ValueObject.php
:
31
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> | [] | - |
getDesignName()
¶
Site.php
:
39
|
|
|
Return values
string
getFirstSiteAccess()
¶
Site.php
:
49
|
|
|
Return values
getTreeRootLocationId()
¶
Site.php
:
44
|
|
|
Return values
int
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>