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

Asset

class Asset extends LocalizedResource

Properties

protected Client $client from BaseResource
protected SystemProperties $sys from BaseResource
protected string[] $localeCodes List of codes for all the locales available in the space this resource belongs to. from LocalizedResource
protected string[] $title
protected string[] $description
protected FileInterface[] $file

Methods

__construct(array $data)

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

from BaseResource
SystemProperties
getSystemProperties()

{@inheritdoc}

from BaseResource
asLink()

{@inheritdoc}

from BaseResource
getId()

{@inheritdoc}

from BaseResource
getType()

{@inheritdoc}

from BaseResource
initLocales(array $locales)

No description

from LocalizedResource
$this
setLocale(Locale|string $locale)

Set the locale for this instance.

from LocalizedResource
string
getLocale()

The locale code for the currently set locale.

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

No description

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

No description

from LocalizedResource
Space
getSpace()

Returns the space this asset belongs to.

Environment
getEnvironment()

Returns the environment this asset belongs to.

string|null
getTitle(Locale|string|null $locale = null)

No description

string|null
getDescription(Locale|string|null $locale = null)

No description

FileInterface|null
getFile(Locale|string|null $locale = null)

No description

jsonSerialize()

{@inheritdoc}

Details

in BaseResource at line 36
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

in BaseResource at line 50
SystemProperties getSystemProperties()

{@inheritdoc}

Return Value

SystemProperties

{@inheritdoc}

in BaseResource at line 69
getId()

{@inheritdoc}

in BaseResource at line 77
getType()

{@inheritdoc}

in LocalizedResource at line 35
initLocales(array $locales)

Parameters

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

in LocalizedResource at line 58
$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

in LocalizedResource at line 70
string getLocale()

The locale code for the currently set locale.

Return Value

string

in LocalizedResource at line 82
protected string getLocaleFromInput(Locale|string|null $input = null)

Parameters

Locale|string|null $input

Return Value

string

Exceptions

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

in LocalizedResource at line 121
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. null if the end of the chain has been reached.

Exceptions

RuntimeException If we detect an endless loop

at line 36
Space getSpace()

Returns the space this asset belongs to.

Return Value

Space

at line 46
Environment getEnvironment()

Returns the environment this asset belongs to.

Return Value

Environment

at line 56
string|null getTitle(Locale|string|null $locale = null)

Parameters

Locale|string|null $locale

Return Value

string|null

at line 66
string|null getDescription(Locale|string|null $locale = null)

Parameters

Locale|string|null $locale

Return Value

string|null

at line 76
FileInterface|null getFile(Locale|string|null $locale = null)

Parameters

Locale|string|null $locale

Return Value

FileInterface|null

at line 107
jsonSerialize()

{@inheritdoc}