Copied!

Location

Location.php : 14
Extends ValueObject

Struct containing accessible properties on Location entities.

Constants

publicSORT_FIELD_CLASS_IDENTIFIER

Location.php : 23 
public mixed SORT_FIELD_CLASS_IDENTIFIER = 6

publicSORT_FIELD_CLASS_NAME

Location.php : 24 
public mixed SORT_FIELD_CLASS_NAME = 7

publicSORT_FIELD_CONTENTOBJECT_ID

Location.php : 29 
public mixed SORT_FIELD_CONTENTOBJECT_ID = 12

publicSORT_FIELD_DEPTH

Location.php : 22 
public mixed SORT_FIELD_DEPTH = 5

publicSORT_FIELD_MODIFIED

Location.php : 20 
public mixed SORT_FIELD_MODIFIED = 3

publicSORT_FIELD_MODIFIED_SUBNODE

Location.php : 27 
public mixed SORT_FIELD_MODIFIED_SUBNODE = 10

publicSORT_FIELD_NAME

Location.php : 26 
public mixed SORT_FIELD_NAME = 9

publicSORT_FIELD_NODE_ID

Location.php : 28 
public mixed SORT_FIELD_NODE_ID = 11

publicSORT_FIELD_PATH

Location.php : 18 
public mixed SORT_FIELD_PATH = 1

publicSORT_FIELD_PRIORITY

Location.php : 25 
public mixed SORT_FIELD_PRIORITY = 8

publicSORT_FIELD_PUBLISHED

Location.php : 19 
public mixed SORT_FIELD_PUBLISHED = 2

publicSORT_FIELD_SECTION

Location.php : 21 
public mixed SORT_FIELD_SECTION = 4

publicSORT_ORDER_ASC

Location.php : 32 
public mixed SORT_ORDER_ASC = 1

publicSORT_ORDER_DESC

Location.php : 31 
public mixed SORT_ORDER_DESC = 0

Properties

public $contentId

Location.php : 82

Content ID.

 
public int $contentId

ID of the corresponding Content.

public $depth

Location.php : 114

Depth location has in the location tree.

 
public int $depth

public $hidden

Location.php : 56

Indicates that the Location entity has been explicitly marked as hidden.

 
public bool $hidden

public $id

Location.php : 39

Location ID.

 
public mixed $id

Location ID.

public $invisible

Location.php : 64

Indicates that the Location is implicitly marked as hidden by a parent location.

 
public bool $invisible

public $parentId

Location.php : 89

Parent ID.

 
public mixed $parentId

Location ID.

public $pathIdentificationString

Location.php : 100

Legacy format of the url alias.

 
public string $pathIdentificationString

This field might be removed in a later version.

Tags
Deprecated

Since 5.4, planned to be removed in 6.0

public $pathString

Location.php : 107

The materialized path of the location entry, eg: /1/2/.

 
public string $pathString

public $priority

Location.php : 49

Location priority.

 
public int $priority

Position of the Location among its siblings when sorted using priority sort order.

public $remoteId

Location.php : 73

Remote ID.

 
public mixed $remoteId

A universally unique identifier.

public $sortField

Location.php : 123

Specifies which property the child locations should be sorted on.

 
public mixed $sortField

Valid values are found at

public $sortOrder

Location.php : 132

Specifies whether the sort order should be ascending or descending.

 
public mixed $sortOrder

Valid values are

Methods

public__construct()

ValueObject.php : 30

Construct object optionally with a set of properties.

 
public __construct([array<string|int, mixed> $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> [] -

protectedgetProperties()

ValueObject.php : 50

Function where list of properties are returned.

 
protected getProperties([array<string|int, mixed> $dynamicProperties = [] ]) : array<string|int, mixed>

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>