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¶
$userGroupSkeletonLocations
¶
|
|
|
Methods¶
__construct()
¶
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> | [] | - |
fromTemplate()
¶
|
|
|
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $identifier | string | - | - |
| $design | string | - | - |
| $template | array<string|int, mixed> | - | - |
| $userGroupSkeletonLocations | array<string|int, mixed> | - | - |
| $siteSkeleton | Location|null | null | - |
| $parentLocation | Location|null | null | - |
Return values
getDesign()
¶
|
|
|
Return values
string
getIdentifier()
¶
|
|
|
Return values
string
getName()
¶
|
|
|
Return values
string
getParentLocation()
¶
|
|
|
Return values
Location|null
getSiteAccessGroup()
¶
|
|
|
Return values
string
getSiteSkeletonLocation()
¶
|
|
|
Return values
Location|null
getThumbnail()
¶
|
|
|
Return values
string
getUserGroupSkeletonLocations()
¶
|
|
|
Return values
array<string|int, Location>
getProperties()
¶
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>