Copied!

Location

Location.php : 33
Abstract
Extends ValueObject

This class represents a location in the repository.

Constants

publicSORT_FIELD_CLASS_IDENTIFIER

Location.php : 41 
public mixed SORT_FIELD_CLASS_IDENTIFIER = 6

publicSORT_FIELD_CLASS_NAME

Location.php : 42 
public mixed SORT_FIELD_CLASS_NAME = 7

publicSORT_FIELD_CONTENTOBJECT_ID

Location.php : 47 
public mixed SORT_FIELD_CONTENTOBJECT_ID = 12

publicSORT_FIELD_DEPTH

Location.php : 40 
public mixed SORT_FIELD_DEPTH = 5

publicSORT_FIELD_MAP

Location.php : 61

Map for Location sort fields to their respective SortClauses.

 
public mixed SORT_FIELD_MAP = [self::SORT_FIELD_PATH => \Ibexa\Contracts\Core\Repository\Values\Content\Query\SortClause\Location\Path::class, self::SORT_FIELD_PUBLISHED => \Ibexa\Contracts\Core\Repository\Values\Content\Query\SortClause\DatePublished::class, self::SORT_FIELD_MODIFIED => \Ibexa\Contracts\Core\Repository\Values\Content\Query\SortClause\DateModified::class, self::SORT_FIELD_SECTION => \Ibexa\Contracts\Core\Repository\Values\Content\Query\SortClause\SectionIdentifier::class, self::SORT_FIELD_DEPTH => \Ibexa\Contracts\Core\Repository\Values\Content\Query\SortClause\Location\Depth::class, self::SORT_FIELD_PRIORITY => \Ibexa\Contracts\Core\Repository\Values\Content\Query\SortClause\Location\Priority::class, self::SORT_FIELD_NAME => \Ibexa\Contracts\Core\Repository\Values\Content\Query\SortClause\ContentName::class, self::SORT_FIELD_NODE_ID => \Ibexa\Contracts\Core\Repository\Values\Content\Query\SortClause\Location\Id::class, self::SORT_FIELD_CONTENTOBJECT_ID => \Ibexa\Contracts\Core\Repository\Values\Content\Query\SortClause\ContentId::class]

Those not here (class name/identifier and modified subnode) are missing/deprecated and will most likely be removed in the future.

publicSORT_FIELD_MODIFIED

Location.php : 38 
public mixed SORT_FIELD_MODIFIED = 3

publicSORT_FIELD_NAME

Location.php : 44 
public mixed SORT_FIELD_NAME = 9

publicSORT_FIELD_NODE_ID

Location.php : 46 
public mixed SORT_FIELD_NODE_ID = 11

publicSORT_FIELD_PATH

Location.php : 36 
public mixed SORT_FIELD_PATH = 1

publicSORT_FIELD_PRIORITY

Location.php : 43 
public mixed SORT_FIELD_PRIORITY = 8

publicSORT_FIELD_PUBLISHED

Location.php : 37 
public mixed SORT_FIELD_PUBLISHED = 2

publicSORT_FIELD_SECTION

Location.php : 39 
public mixed SORT_FIELD_SECTION = 4

publicSORT_ORDER_ASC

Location.php : 50 
public mixed SORT_ORDER_ASC = 1

publicSORT_ORDER_DESC

Location.php : 49 
public mixed SORT_ORDER_DESC = 0

publicSORT_ORDER_MAP

Location.php : 76

Map for Location sort order to their respective Query SORT constants.

 
public mixed SORT_ORDER_MAP = [self::SORT_ORDER_DESC => \Ibexa\Contracts\Core\Repository\Values\Content\Query::SORT_DESC, self::SORT_ORDER_ASC => \Ibexa\Contracts\Core\Repository\Values\Content\Query::SORT_ASC]

publicSTATUS_DRAFT

Location.php : 52 
public mixed STATUS_DRAFT = 0

publicSTATUS_PUBLISHED

Location.php : 53 
public mixed STATUS_PUBLISHED = 1

Properties

public $contentId read-only

Location.php 
public int $contentId

Accessing magic getter is deprecated since 4.6.7 and will be removed in 5.0.0. Use Location::getContentId() instead.

public $contentInfo read-only

Location.php 
public ContentInfo $contentInfo

Calls Location::getContentInfo()

public $status

Location.php : 89

The status of the location.

 
public int $status = self::STATUS_PUBLISHED

A location gets the status Location::STATUS_DRAFT on newly created content which is not published. When content is published the location gets the status Location::STATUS_PUBLISHED.

protected $content

Location.php : 161 
protected Content $content

protected $depth

Location.php : 145

Depth location has in the location tree.

 
protected int $depth = 0

protected $explicitlyHidden

Location.php : 113

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

 
protected bool $explicitlyHidden = false

protected $hidden

Location.php : 102

Indicates that the Location entity is hidden (explicitly or hidden by content).

 
protected bool $hidden = false

protected $id

Location.php : 81 
protected int $id

protected $invisible

Location.php : 108

Indicates that the Location is not visible, being either marked as hidden itself, or implicitly hidden by its Content or an ancestor Location.

 
protected bool $invisible = false

protected $parentLocationId

Location.php : 125

Parent ID.

 
protected int $parentLocationId

protected $path

Location.php : 140

The list of ancestor locations' IDs, ordered by increasing depth, starting with '1', and ending with the current Location's ID.

 
protected array<string|int, mixed> $path = []

Same as Location::$pathString but as array, e.g.: ['1', '2', '4', '23'].

protected $pathString

Location.php : 130

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

 
protected string $pathString

protected $priority

Location.php : 97

Location priority.

 
protected int $priority

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

protected $remoteId

Location.php : 120

Remote ID.

 
protected string $remoteId

A universally unique identifier.

protected $sortField

Location.php : 152

Specifies which property the child locations should be sorted on.

 
protected int $sortField

Valid values are found at

protected $sortOrder

Location.php : 159

Specifies whether the sort order should be ascending or descending.

 
protected int $sortOrder

Valid values are

Methods

public__construct()

ValueObject.php : 32

Construct object optionally with a set of properties.

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

public__get()

Location.php : 281 
public __get(mixed $property) : mixed

Parameters

Name Type Default value Description
$property mixed - -
Tags
Deprecated
4.6.7

accessing magic getter is deprecated and will be removed in 5.0.0.

public__isset()

Location.php : 271 
public __isset(mixed $property) : mixed

Parameters

Name Type Default value Description
$property mixed - -
Tags
Deprecated
4.6.7

accessing magic getter is deprecated and will be removed in 5.0.0.

publicgetContent()

Location.php : 193 
public getContent() : Content

Return values

Content

publicgetContentId()

Location.php : 180 
public getContentId() : int

Return values

int

publicgetContentInfo()

Location.php : 168

Returns the content info of the content object of this location.

 
public abstract getContentInfo() : ContentInfo

Return values

ContentInfo

publicgetDepth()

Location.php : 265 
public getDepth() : int

Return values

int

publicgetId()

Location.php : 175 
public getId() : int

Return values

int

publicgetParentLocation()

Location.php : 173

Return the parent location of this location.

 
public abstract getParentLocation() : Location|null

Return values

Location|null

publicgetPath()

Location.php : 237

The list of ancestor locations' IDs, ordered by increasing depth, starting with 1, and ending with the current Location's ID.

 
public getPath() : array<string|int, mixed>

Same as Location::getPathString() but as array, e.g.: ['1', '2', '4', '23'].

Return values

array<string|int, mixed>

publicgetPathString()

Location.php : 224

The path to the Location represented by the current instance, e.g. /1/2/4/23/ where 23 is current ID.

 
public getPathString() : string

Return values

string

publicgetSortClauses()

Location.php : 205

Get SortClause objects built from Locations' sort options.

 
public getSortClauses() : array<string|int, SortClause>

Return values

array<string|int, SortClause>

Tags
Throws
NotImplementedException

If sort field has a deprecated/unsupported value which does not have a Sort Clause.

publicisDraft()

Location.php : 188

Returns true if current location is a draft.

 
public isDraft() : bool

Return values

bool

publicisHidden()

Location.php : 260

Indicates that the Location is hidden either explicitly or by content.

 
public isHidden() : bool

Return values

bool

publicisInvisible()

Location.php : 252

Indicates that the Location is not visible, being either marked as hidden itself, or implicitly hidden by its Content or an ancestor Location.

 
public isInvisible() : bool

Return values

bool

protectedgetProperties()

ValueObject.php : 53

Returns list of available properties' names.

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

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>

Attributes
#[Ignore]