URLAlias

URLAlias.php : 26 Copy path

Extends ValueObject

This class represents a url alias in the repository.

Constants¶

LOCATION ¶

URLAlias.php : 28 Copy path

public mixed LOCATION = 0

RESOURCE ¶

URLAlias.php : 29 Copy path

public mixed RESOURCE = 1

VIRTUAL ¶

URLAlias.php : 30 Copy path

public mixed VIRTUAL = 2

Properties¶

$alwaysAvailable read-only ¶

URLAlias.php Copy path

public bool $alwaysAvailable

Fallback indicator for other languages

$destination read-only ¶

URLAlias.php Copy path

public mixed $destination

If type = URLAlias::LOCATION it is a Location id otherwise a string (e.g. /content/search)

$forward read-only ¶

URLAlias.php Copy path

public bool $forward

Indicates if the url should be redirected

$id read-only ¶

URLAlias.php Copy path

public string $id

A unique identifier for the alias

$isCustom read-only ¶

URLAlias.php Copy path

public bool $isCustom

If false this alias was autogenerated otherwise manuel created

$isHistory read-only ¶

URLAlias.php Copy path

public bool $isHistory

Indicates that this alias was autogenerated for an in the meanwhile archived version of the content

$languageCodes read-only ¶

URLAlias.php Copy path

public array<string|int, string> $languageCodes

the languages for which this alias is valid

$path read-only ¶

URLAlias.php Copy path

public string $path

the alias path

$type read-only ¶

URLAlias.php Copy path

public int $type

The type of the URL Alias i.e. one of URLAlias::LOCATION, URLAlias::RESOURCE, URLAlias::VIRTUAL

$alwaysAvailable ¶

URLAlias.php : 76 Copy path

Fallback indicator for other languages.

protected bool $alwaysAvailable

$destination ¶

URLAlias.php : 55 Copy path

If type = URLAlias::LOCATION it is a Location id otherwise a string (e.g. /content/search).

protected mixed $destination

$forward ¶

URLAlias.php : 97 Copy path

Indicates if the url should be redirected.

protected bool $forward

$id ¶

URLAlias.php : 40 Copy path

A unique identifier for the alias (in legacy implementation this would be <parentid>-<md5text>).

protected string $id

Note: currently this will only be unique when $isHistory flag is false.

$isCustom ¶

URLAlias.php : 90 Copy path

If false this alias was autogenerated otherwise manually created.

protected bool $isCustom

$isHistory ¶

URLAlias.php : 83 Copy path

Indicates that this alias was autogenerated for an in the meanwhile archived version of the content.

protected bool $isHistory

$languageCodes ¶

URLAlias.php : 69 Copy path

The languageCodes for which this path is valid.

protected array<string|int, string> $languageCodes

$path ¶

URLAlias.php : 62 Copy path

the full path of the alias.

protected string $path

$type ¶

URLAlias.php : 47 Copy path

The type of the URL Alias i.e. one of URLAlias::LOCATION, URLAlias::RESOURCE, URLAlias::VIRTUAL.

protected int $type

Methods¶

__construct() ¶

ValueObject.php : 30 Copy path

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>	[]	-

getProperties() ¶

ValueObject.php : 50 Copy path

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>