Copied!

Location

Location.php : 33
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 : 52 
public mixed SORT_FIELD_CONTENTOBJECT_ID = 12

publicSORT_FIELD_DEPTH

Location.php : 40 
public mixed SORT_FIELD_DEPTH = 5

publicSORT_FIELD_MAP

Location.php : 66

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_CLASS_IDENTIFIER => false,
    //self::SORT_FIELD_CLASS_NAME => false,
    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_MODIFIED_SUBNODE => false,
    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_MODIFIED_SUBNODE

Location.php : 49 
public mixed SORT_FIELD_MODIFIED_SUBNODE = 10
Tags
Deprecated

publicSORT_FIELD_NAME

Location.php : 44 
public mixed SORT_FIELD_NAME = 9

publicSORT_FIELD_NODE_ID

Location.php : 51 
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 : 55 
public mixed SORT_ORDER_ASC = 1

publicSORT_ORDER_DESC

Location.php : 54 
public mixed SORT_ORDER_DESC = 0

publicSORT_ORDER_MAP

Location.php : 84

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 : 57 
public mixed STATUS_DRAFT = 0

publicSTATUS_PUBLISHED

Location.php : 58 
public mixed STATUS_PUBLISHED = 1

Properties

public $contentId read-only

Location.php 
public int $contentId

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

public $contentInfo read-only

Location.php 
public ContentInfo $contentInfo

calls getContentInfo()

public $depth read-only

Location.php 
public int $depth

@deprecated 4.6.7 accessing magic getter is deprecated and will be removed in 5.0.0. Use Location::getDepth() instead.

public $explicitlyHidden read-only

Location.php 
public bool $explicitlyHidden

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

public $hidden read-only

Location.php 
public bool $hidden

@deprecated 4.6.7 accessing magic getter is deprecated and will be removed in 5.0.0. Use Location::isHidden() instead.

public $id read-only

Location.php 
public int $id

@deprecated 4.6.7 accessing magic getter is deprecated and will be removed in 5.0.0. Use Location::getId() instead.

public $invisible read-only

Location.php 
public bool $invisible

@deprecated 4.6.7 accessing magic getter is deprecated and will be removed in 5.0.0. Use Location::isInvisible() instead.

public $parentLocationId read-only

Location.php 
public int $parentLocationId

the id of the parent location

public $path read-only

Location.php 
public array<string|int, mixed> $path

@deprecated 4.6.7 accessing magic getter is deprecated and will be removed in 5.0.0. Use Location::getPath() instead.

public $pathString read-only

Location.php 
public string $pathString

@deprecated 4.6.7 accessing magic getter is deprecated and will be removed in 5.0.0. Use Location::getPathString() instead.

public $priority read-only

Location.php 
public int $priority

Position of the Location among its siblings when sorted using priority

public $remoteId read-only

Location.php 
public string $remoteId

a global unique id of the content object

public $sortField read-only

Location.php 
public int $sortField

Specifies which property the child locations should be sorted on. Valid values are found at

public $sortOrder read-only

Location.php 
public int $sortOrder

Specifies whether the sort order should be ascending or descending. Valid values are

public $status

Location.php : 104

the status of the location.

 
public int $status = self::STATUS_PUBLISHED

a location gets the status DRAFT on newly created content which is not published. When content is published the location gets the status STATUS_PUBLISHED

protected $content

Location.php : 194 
protected Content $content

protected $depth

Location.php : 173

Depth location has in the location tree.

 
protected int $depth

protected $explicitlyHidden

Location.php : 136

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

 
protected bool $explicitlyHidden

protected $hidden

Location.php : 121

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

 
protected bool $hidden

protected $id

Location.php : 94

Location ID.

 
protected int $id

Location ID.

protected $invisible

Location.php : 129

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

protected $parentLocationId

Location.php : 152

Parent ID.

 
protected int $parentLocationId

Location ID.

protected $path

Location.php : 166

Same as {@see Location::$pathString} but as array, e.g.: <code>[ '1', '2', '4', '23' ]</code>.

 
protected array<string|int, string> $path

protected $pathString

Location.php : 159

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

 
protected string $pathString

protected $priority

Location.php : 114

Location priority.

 
protected int $priority

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

protected $remoteId

Location.php : 145

Remote ID.

 
protected string $remoteId

A universally unique identifier.

protected $sortField

Location.php : 182

Specifies which property the child locations should be sorted on.

 
protected int $sortField

Valid values are found at

protected $sortOrder

Location.php : 191

Specifies whether the sort order should be ascending or descending.

 
protected int $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> [] -

public__get()

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

Parameters

Name Type Default value Description
$property mixed - -

public__isset()

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

Parameters

Name Type Default value Description
$property mixed - -

publicgetContent()

Location.php : 233 
public getContent() : Content

Return values

Content

publicgetContentId()

Location.php : 215 
public getContentId() : int

Return values

int

publicgetContentInfo()

Location.php : 201

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

 
public abstract getContentInfo() : ContentInfo

Return values

ContentInfo

publicgetDepth()

Location.php : 302 
public getDepth() : int

Return values

int

publicgetId()

Location.php : 210 
public getId() : int

Return values

int

publicgetParentLocation()

Location.php : 208

Return the parent location of this location.

 
public abstract getParentLocation() : Location|null

Return values

Location|null

publicgetPath()

Location.php : 274

Same as {@see Location::getPathString()} but as array, e.g.: <code>[ '1', '2', '4', '23' ]</code>.

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

Return values

array<string|int, string>

publicgetPathString()

Location.php : 264

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 : 245

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 : 225

Returns true if current location is a draft.

 
public isDraft() : bool

Return values

bool

publicisHidden()

Location.php : 297

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

 
public isHidden() : bool

Return values

bool

publicisInvisible()

Location.php : 289

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 : 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>