Struct containing accessible properties on Location entities.
Constants¶
SORT_FIELD_CLASS_IDENTIFIER ¶
|
|
|
SORT_FIELD_CLASS_NAME ¶
|
|
|
SORT_FIELD_CONTENTOBJECT_ID ¶
|
|
|
SORT_FIELD_DEPTH ¶
|
|
|
SORT_FIELD_MODIFIED ¶
|
|
|
SORT_FIELD_MODIFIED_SUBNODE ¶
|
|
|
SORT_FIELD_NAME ¶
|
|
|
SORT_FIELD_NODE_ID ¶
|
|
|
SORT_FIELD_PATH ¶
|
|
|
SORT_FIELD_PRIORITY ¶
|
|
|
SORT_FIELD_PUBLISHED ¶
|
|
|
SORT_FIELD_SECTION ¶
|
|
|
SORT_ORDER_ASC ¶
|
|
|
SORT_ORDER_DESC ¶
|
|
|
Properties¶
$contentId
¶
Content ID.
|
|
|
ID of the corresponding Content.
$depth
¶
Depth location has in the location tree.
|
|
|
$hidden
¶
Indicates that the Location entity has been explicitly marked as hidden.
|
|
|
$id
¶
Location ID.
|
|
|
Location ID.
$invisible
¶
Indicates that the Location is implicitly marked as hidden by a parent location.
|
|
|
$parentId
¶
Parent ID.
|
|
|
Location ID.
$pathIdentificationString
¶
Legacy format of the url alias.
|
|
|
This field might be removed in a later version.
Tags
$pathString
¶
The materialized path of the location entry, eg: /1/2/.
|
|
|
$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 are not writable anymore after object has been created.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $properties | array<string|int, mixed> | [] | - |
getProperties()
¶
Function where list of properties are returned.
|
|
|
Used by attributes(), override to add dynamic properties
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $dynamicProperties | array<string|int, mixed> | [] |
Additional dynamic properties exposed on the object |
Return values
array<string|int, mixed>