1. class
  2. Contentful
  3. \
  4. Delivery
  5. \
  6. Resource
  7. \
  8. LocalizedResource

LocalizedResource

class LocalizedResource extends BaseResource

A LocalizedResource can store information for multiple locales.

The methods in this base class allow switching between the locales.

Properties

protected string[] $localeCodes List of codes for all the locales available in the space this resource belongs to.
LocalizedResource $sys

Methods

__construct(array $data)

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

from BaseResource
asLink()

{@inheritdoc}

from BaseResource
getId()

{@inheritdoc}

from BaseResource
getType()

{@inheritdoc}

from BaseResource
initLocales(array $locales)

No description

$this
setLocale(Locale|string $locale)

Set the locale for this instance.

getLocale()

The locale code for the currently set locale.

getLocaleFromInput(Locale|string|null $input = null)

No description

string|null
walkFallbackChain(array $valueMap, string $localeCode, Environment $environment)

No description

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 41
initLocales(array $locales)

Parameters

array $locales The locales available in the space this resource belongs to

at line 65
$this setLocale(Locale|string $locale)

Set the locale for this instance.

All future calls to a getter will return the information for this locale.

Parameters

Locale|string $locale The locale code as string or an instance of Locale

Return Value

$this

at line 77
getLocale()

The locale code for the currently set locale.

It will be either the default locale if the resource was fetched using "locale=*", or the one that was used in the API request.

at line 87
protected getLocaleFromInput(Locale|string|null $input = null)

Parameters

Locale|string|null $input

Exceptions

InvalidArgumentException when $locale is not one of the locales supported by the space

at line 113
protected string|null walkFallbackChain(array $valueMap, string $localeCode, Environment $environment)

Parameters

array $valueMap
string $localeCode
Environment $environment

Return Value

string|null the locale code for which a value can be found, or null if the end of the chain was reached

Exceptions

RuntimeException If we detect an endless loop