class Locale extends BaseResource

Value object encoding a locale.

Properties

protected Locale $sys
protected string $code
protected string $name
protected string|null $fallbackCode
protected bool $default

Methods

__construct(array $data)

Resources in this SDK should not be built using $new Class().

asLink()

{@inheritdoc}

getId()

{@inheritdoc}

getType()

{@inheritdoc}

getSystemProperties()

{@inheritdoc}

getCode()

Returns the locale code.

getName()

Returns the human readable name.

isDefault()

Returns true if this is the default locale for the space.

string|null
getFallbackCode()

Returns the code of the locale used for for the fallback.

jsonSerialize()

{@inheritdoc}

Details

in BaseResource at line 24
protected __construct(array $data)

Resources in this SDK should not be built using $new Class().

This method is only useful in testing environments, where the resource needs to be subclasses and this method made public.

Parameters

array $data

{@inheritdoc}

in BaseResource at line 47
getId()

{@inheritdoc}

in BaseResource at line 55
getType()

{@inheritdoc}

at line 49
getSystemProperties()

{@inheritdoc}

at line 57
getCode()

Returns the locale code.

at line 65
getName()

Returns the human readable name.

at line 73
isDefault()

Returns true if this is the default locale for the space.

at line 83
string|null getFallbackCode()

Returns the code of the locale used for for the fallback.

Return Value

string|null

at line 91
jsonSerialize()

{@inheritdoc}