class Entry extends BaseProxy

Entries class.

This class is used as a proxy for doing operations related to entries.

Properties

protected Client $client from BaseProxy
protected string|null $spaceId from BaseProxy
protected bool $requiresSpaceId Whether the current proxy requires a space ID for working properly. from BaseProxy

Methods

__construct(Client $client, string $spaceId = null)

BaseProxy constructor.

from BaseProxy
__call(string $name, array $arguments)

Acts as a whitelister for protected methods.

from BaseProxy
string|null
getBaseUri()

Returns the string to be used as baseUri option, or null otherwise.

from BaseProxy
ResourceInterface|ResourceArray
getResource(array $values, Query $query = null, ResourceInterface $resource = null)

No description

from BaseProxy
requestResource(string $method, string $uriSuffix, ResourceInterface|string $resource, int $version = null, mixed $body = null)

No description

from BaseProxy
string
getResourceId(ResourceInterface|string $resource)

No description

from BaseProxy
ResourceInterface
create(Entry $resource, string $resourceId = null)

No description

string[]
getCreateAdditionalHeaders(ResourceInterface $resource)

Override this method in a proxy class if special headers are to be defined upon creation.

ResourceInterface
update(Entry $resource)

No description

ResourceInterface
delete(Entry|string $resource, int $version = null)

No description

ResourceInterface
archive(Entry|string $resource, int $version = null)

No description

ResourceInterface
unarchive(Entry|string $resource, int $version = null)

No description

ResourceInterface
publish(Entry|string $resource, int $version = null)

No description

ResourceInterface
unpublish(Entry|string $resource, int $version = null)

No description

string
getResourceUri(array $values)

Returns the URI for the current proxy type.

string[]
getEnabledMethods()

An array of enabled methods for the current proxy.

get(string $resourceId)

Returns an Entry object which corresponds to the given resource ID in Contentful.

ResourceArray
getAll(Query $query = null)

Returns a ResourceArray object containing Entry objects.

Details

in BaseProxy at line 52
__construct(Client $client, string $spaceId = null)

BaseProxy constructor.

Parameters

Client $client
string $spaceId

in BaseProxy at line 76
ResourceInterface __call(string $name, array $arguments)

Acts as a whitelister for protected methods.

Parameters

string $name
array $arguments

Return Value

ResourceInterface

Exceptions

LogicException

in BaseProxy at line 91
protected string|null getBaseUri()

Returns the string to be used as baseUri option, or null otherwise.

Return Value

string|null

in BaseProxy at line 103
protected ResourceInterface|ResourceArray getResource(array $values, Query $query = null, ResourceInterface $resource = null)

Parameters

array $values
Query $query
ResourceInterface $resource

Return Value

ResourceInterface|ResourceArray

in BaseProxy at line 130
protected ResourceInterface requestResource(string $method, string $uriSuffix, ResourceInterface|string $resource, int $version = null, mixed $body = null)

Parameters

string $method
string $uriSuffix
ResourceInterface|string $resource
int $version
mixed $body

Return Value

ResourceInterface

in BaseProxy at line 158
protected string getResourceId(ResourceInterface|string $resource)

Parameters

ResourceInterface|string $resource

Return Value

string

at line 30
ResourceInterface create(Entry $resource, string $resourceId = null)

Parameters

Entry $resource
string $resourceId

Return Value

ResourceInterface

at line 51
protected string[] getCreateAdditionalHeaders(ResourceInterface $resource)

Override this method in a proxy class if special headers are to be defined upon creation.

Parameters

ResourceInterface $resource

Return Value

string[]

at line 30
ResourceInterface update(Entry $resource)

Parameters

Entry $resource

Return Value

ResourceInterface

at line 30
ResourceInterface delete(Entry|string $resource, int $version = null)

Parameters

Entry|string $resource
int $version

Return Value

ResourceInterface

at line 30
ResourceInterface archive(Entry|string $resource, int $version = null)

Parameters

Entry|string $resource
int $version

Return Value

ResourceInterface

at line 30
ResourceInterface unarchive(Entry|string $resource, int $version = null)

Parameters

Entry|string $resource
int $version

Return Value

ResourceInterface

at line 30
ResourceInterface publish(Entry|string $resource, int $version = null)

Parameters

Entry|string $resource
int $version

Return Value

ResourceInterface

at line 30
ResourceInterface unpublish(Entry|string $resource, int $version = null)

Parameters

Entry|string $resource
int $version

Return Value

ResourceInterface

at line 35
protected string getResourceUri(array $values)

Returns the URI for the current proxy type.

Parameters

array $values

Return Value

string

at line 43
string[] getEnabledMethods()

An array of enabled methods for the current proxy.

Return Value

string[]

at line 65
Entry get(string $resourceId)

Returns an Entry object which corresponds to the given resource ID in Contentful.

Parameters

string $resourceId

Return Value

Entry

See also

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

at line 81
ResourceArray getAll(Query $query = null)

Returns a ResourceArray object containing Entry objects.

Parameters

Query $query

Return Value

ResourceArray

See also

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