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

Entry

class Entry extends LocalizedResource implements ArrayAccess

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 array $fields

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 entry belongs to.

Environment
getEnvironment()

Returns the environment this entry belongs to.

ContentType|null
getContentType()

No description

mixed
__call(string $name, array $arguments)

No description

mixed
__get(string $name)

Shortcut for accessing fields using $entry->fieldName.

offsetGet($name)

{@inheritdoc}

offsetExists($name)

{@inheritdoc}

offsetSet($name, $value)

{@inheritdoc}

offsetUnset($name)

{@inheritdoc}

bool
has(string $name)

Checks whether the current entry has a field with a certain ID.

mixed
get(string $name, string|null $locale = null, bool $resolveLinks = true)

Returns a the value of a field using the given locale.

ResourceArray
getReferences(Query $query = null)

Gets all entries that contain links to the current one.

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 30
Space getSpace()

Returns the space this entry belongs to.

Return Value

Space

at line 40
Environment getEnvironment()

Returns the environment this entry belongs to.

Return Value

Environment

at line 48
ContentType|null getContentType()

Return Value

ContentType|null

at line 59
mixed __call(string $name, array $arguments)

Parameters

string $name
array $arguments

Return Value

mixed

at line 103
mixed __get(string $name)

Shortcut for accessing fields using $entry->fieldName.

It will use the locale currently defined.

Parameters

string $name

Return Value

mixed

at line 111
offsetGet($name)

{@inheritdoc}

Parameters

$name

at line 119
offsetExists($name)

{@inheritdoc}

Parameters

$name

at line 127
offsetSet($name, $value)

{@inheritdoc}

Parameters

$name
$value

at line 135
offsetUnset($name)

{@inheritdoc}

Parameters

$name

at line 147
bool has(string $name)

Checks whether the current entry has a field with a certain ID.

Parameters

string $name

Return Value

bool

at line 171
mixed get(string $name, string|null $locale = null, bool $resolveLinks = true)

Returns a the value of a field using the given locale.

It will also resolve links. If you want to access the ID of a link or of an array of links, simply append "Id" to the end of the $name parameter.

$author = $entry->get('author');
$id = $entry->get('authorId');

Parameters

string $name
string|null $locale
bool $resolveLinks If set to false, links and array of links will not be resolved

Return Value

mixed

at line 328
ResourceArray getReferences(Query $query = null)

Gets all entries that contain links to the current one.

You can provide a Query object in order to set parameters such as locale, include, and sorting.

Parameters

Query $query

Return Value

ResourceArray

at line 339
jsonSerialize()

{@inheritdoc}