Base SPI Value object.
All properties of SPI\ValueObject must be serializable for cache & NoSQL use.
Properties¶
$contentId
¶
Content ID.
|
|
|
ID of the corresponding Content.
$contentVersion
¶
Content version.
|
|
|
Version of the corresponding Content.
$hidden
¶
Indicates that the Location entity has been explicitly marked as hidden.
|
|
|
$invisible
¶
Indicates that the Location is implicitly marked as hidden by a parent location.
|
|
|
$mainLocationId
¶
Identifier of the main location.
|
|
|
If the content object in this location has multiple locations, $mainLocationId will point to the main one. This is allowed to be set to true, this will mean this should become main location (@todo Find a better way to deal with being able to create the main location)
$parentId
¶
Parent location's Id.
|
|
|
$pathIdentificationString
¶
Legacy format of the url alias.
|
|
|
This field might be removed in a later version.
Tags
$priority
¶
Location priority.
|
|
|
Position of the Location among its siblings when sorted using priority sort order.
$remoteId
¶
Remote ID.
|
|
|
A universally unique identifier.
$sortField
¶
Specifies which property the child locations should be sorted on.
|
|
|
$sortOrder
¶
Specifies whether the sort order should be ascending or descending.
|
|
|
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> | [] | - |
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>