class Entry extends BaseResource implements CreatableInterface

Entry class.

This class represents a resource with type "Entry" in Contentful.

Traits

EntryProxyExtension trait.
ArchivableTrait.
DeletableTrait.
PublishableTrait.
UpdatableTrait.

Properties

SystemProperties $sys from UpdatableTrait
Client $client from UpdatableTrait
protected array[] $fields

Methods

initialize(string $type, array $sys = [])

Initialize system properties.

getSystemProperties()

{@inheritdoc}

getId()

{@inheritdoc}

getType()

{@inheritdoc}

asLink()

{@inheritdoc}

mixed
asRequestBody()

Returns the resource in the form of request body.

setClient(Client $client)

Sets the current Client object instance.

getSpaceId()

{@inheritdoc}

getEnvironmentId()

{@inheritdoc}

getEntryId()

{@inheritdoc}

getSnapshot(string $snapshotId)

Returns a EntrySnapshot resource.

ResourceArray
getSnapshots(Query $query = null)

Returns a ResourceArray object which contains EntrySnapshot resources.

archive()

Archives the current resource.

unarchive()

Unarchives the current resource.

delete()

Deletes the current resource.

publish()

Publishes the current resource.

unpublish()

Unpublishes the current resource.

update()

Deletes the current resource.

__construct(string $contentTypeId)

Entry constructor.

array
jsonSerialize()

Returns an array to be used by "json_encode" to serialize objects of this class.

string[]
asUriParameters()

Returns an associate array where keys are the name of the fragments in a URI, and the values are the corresponding IDs.

string[]
getHeadersForCreation()

Returns an array of headers that the current resource needs to sent for being created.

mixed
getField(string $name, string $locale)

No description

array
getFields(string $locale = null)

No description

setField(string $name, string $locale, mixed $value)

No description

mixed
__call(string $name, array $arguments)

Provides simple setX/getX capabilities, without recurring to code generation.

Details

in BaseResource at line 39
protected initialize(string $type, array $sys = [])

Initialize system properties.

Parameters

string $type The system type
array $sys

in BaseResource at line 48
getSystemProperties()

{@inheritdoc}

in BaseResource at line 56
getId()

{@inheritdoc}

in BaseResource at line 64
getType()

{@inheritdoc}

{@inheritdoc}

in UpdatableTrait at line 33
abstract mixed asRequestBody()

Returns the resource in the form of request body.

This can differ from regular serialization, as some fields may not be present in the request payload.

Return Value

mixed

in BaseResource at line 98
BaseResource setClient(Client $client)

Sets the current Client object instance.

This is done automatically when performing API calls, so it shouldn't be used manually.

Parameters

Client $client

Return Value

BaseResource

at line 97
protected getSpaceId()

{@inheritdoc}

at line 105
protected getEnvironmentId()

{@inheritdoc}

at line 113
protected getEntryId()

{@inheritdoc}

in EntryProxyExtension at line 59
EntrySnapshot getSnapshot(string $snapshotId)

Returns a EntrySnapshot resource.

Parameters

string $snapshotId

Return Value

EntrySnapshot

See also

https://www.contentful.com/developers/docs/references/content-management-api/#/reference/snapshots/entry-snapshot

in EntryProxyExtension at line 78
ResourceArray getSnapshots(Query $query = null)

Returns a ResourceArray object which contains EntrySnapshot resources.

Parameters

Query $query

Return Value

ResourceArray

See also

https://www.contentful.com/developers/docs/references/content-management-api/#/reference/snapshots/entry-snapshots-collection

in ArchivableTrait at line 29
archive()

Archives the current resource.

in ArchivableTrait at line 39
unarchive()

Unarchives the current resource.

in DeletableTrait at line 29
delete()

Deletes the current resource.

in PublishableTrait at line 29
publish()

Publishes the current resource.

in PublishableTrait at line 39
unpublish()

Unpublishes the current resource.

in UpdatableTrait at line 38
update()

Deletes the current resource.

at line 46
__construct(string $contentTypeId)

Entry constructor.

Parameters

string $contentTypeId

at line 64
array jsonSerialize()

Returns an array to be used by "json_encode" to serialize objects of this class.

Return Value

array

at line 85
string[] asUriParameters()

Returns an associate array where keys are the name of the fragments in a URI, and the values are the corresponding IDs.

Return Value

string[]

at line 121
string[] getHeadersForCreation()

Returns an array of headers that the current resource needs to sent for being created.

This method is supposed to be overridden if necessary.

Return Value

string[]

at line 152
mixed getField(string $name, string $locale)

Parameters

string $name
string $locale

Return Value

mixed

at line 162
array getFields(string $locale = null)

Parameters

string $locale

Return Value

array

at line 183
Entry setField(string $name, string $locale, mixed $value)

Parameters

string $name
string $locale
mixed $value

Return Value

Entry

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

Provides simple setX/getX capabilities, without recurring to code generation.

Parameters

string $name
array $arguments

Return Value

mixed