Copied!

UrlAlias

UrlAlias.php : 16
Extends ValueObject

UrlAlias models one url alias path element separated by '/' in urls.

This class models the legacy structure used for url aliases.

Constants

publicLOCATION

UrlAlias.php : 18
public mixed LOCATION = 0

publicRESOURCE

UrlAlias.php : 19
public mixed RESOURCE = 1

publicVIRTUAL

UrlAlias.php : 20
public mixed VIRTUAL = 2

Properties

public $alwaysAvailable

UrlAlias.php : 83

Fallback indicator for other languages.

public bool $alwaysAvailable

public $destination

UrlAlias.php : 43

If type = URLAlias::LOCATION the locationId otherwise a string (e.g. /content/search).

public mixed $destination

public $forward

UrlAlias.php : 104

Indicates if the url should be redirected.

public bool $forward

public $id

UrlAlias.php : 28

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

public string $id

public $isCustom

UrlAlias.php : 97

If false this alias was autogenerated otherwise manuel created.

public bool $isCustom

public $isHistory

UrlAlias.php : 90

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

public bool $isHistory

public $languageCodes

UrlAlias.php : 76

Language code of url alias entry.

public array<string|int, string> $languageCodes

public $pathData

UrlAlias.php : 69

Holds normalized path data.

public array<string|int, mixed> $pathData

Example: array( array( "always-available" => true, "translations" => array( "cro-HR" => "jedan" ) ), array( "always-available" => false, "translations" => array( "cro-HR" => "dva", "eng-GB" => "two", ) ) )

public $type

UrlAlias.php : 35

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

public int $type

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>