1. class
  2. Contentful
  3. \
  4. Management
  5. \
  6. Proxy
  7. \
  8. BaseProxy

BaseProxy

class BaseProxy

BaseProxy class.

Properties

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

Methods

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

BaseProxy constructor.

ResourceInterface
__call(string $name, array $arguments)

Acts as a whitelister for protected methods.

string|null
getBaseUri()

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

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

No description

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

No description

string
getResourceId(ResourceInterface|string $resource)

No description

create(Creatable $resource, string $resourceId = null)

Creates a resource.

string[]
getCreateAdditionalHeaders(ResourceInterface $resource)

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

update(Updatable $resource)

Updates a resource.

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

Deletes a resource.

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

Archives a resource.

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

Unarchives a resource.

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

Publishes a resource.

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

Unpublishes a resource.

string
getResourceUri(array $values)

Returns the URI for the current proxy type.

string[]
getEnabledMethods()

An array of enabled methods for the current proxy.

Details

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

BaseProxy constructor.

Parameters

Client $client
string $spaceId

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

at line 91
protected string|null getBaseUri()

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

Return Value

string|null

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

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

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

Parameters

ResourceInterface|string $resource

Return Value

string

at line 173
protected create(Creatable $resource, string $resourceId = null)

Creates a resource.

Parameters

Creatable $resource
string $resourceId

at line 198
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 208
protected update(Updatable $resource)

Updates a resource.

Parameters

Updatable $resource

at line 219
protected delete(ResourceInterface|string $resource, int $version = null)

Deletes a resource.

Parameters

ResourceInterface|string $resource Either a resource object, or a resource ID
int $version Null if $resouce is an object

at line 234
protected archive(ResourceInterface|string $resource, int $version = null)

Archives a resource.

Parameters

ResourceInterface|string $resource Either a resource object, or a resource ID
int $version Null if $resouce is an object

at line 249
protected unarchive(ResourceInterface|string $resource, int $version = null)

Unarchives a resource.

Parameters

ResourceInterface|string $resource Either a resource object, or a resource ID
int $version Null if $resouce is an object

at line 264
protected publish(ResourceInterface|string $resource, int $version = null)

Publishes a resource.

Parameters

ResourceInterface|string $resource Either a resource object, or a resource ID
int $version Null if $resouce is an object

at line 279
protected unpublish(ResourceInterface|string $resource, int $version = null)

Unpublishes a resource.

Parameters

ResourceInterface|string $resource Either a resource object, or a resource ID
int $version Null if $resouce is an object

at line 295
abstract protected string getResourceUri(array $values)

Returns the URI for the current proxy type.

Parameters

array $values

Return Value

string

at line 302
abstract string[] getEnabledMethods()

An array of enabled methods for the current proxy.

Return Value

string[]