This class is used to create a new Location for a content object.
Properties¶
$hidden
¶
Indicates that the Location entity has been explicitly marked as hidden.
|
|
|
$parentLocationId
¶
The id of the parent location under which the new location should be created.
|
|
|
Required.
$priority
¶
Location priority.
|
|
|
Position of the Location among its siblings when sorted using priority sort order.
$remoteId
¶
An universally unique string identifier.
|
|
|
Needs to be a unique Location->remoteId string value.
$sortField
¶
Specifies which property the child locations should be sorted on.
|
|
|
If not set, will be taken out of ContentType's default sort field
$sortOrder
¶
Specifies whether the sort order should be ascending or descending.
|
|
|
If not set, will be taken out of ContentType's default sort order
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>