1. interface
  2. Contentful
  3. \
  4. Core
  5. \
  6. Api
  7. \
  8. ClientInterface

ClientInterface

interface ClientInterface

Methods

ResourceInterface
request(string $method, string $uri, array $options = [])

Sends a request to the API, and returns a resource object.

useApplication(ApplicationInterface $application)

Sets the current application.

setApplication(string $name, string $version = '') deprecated

Set the application name and version.

useIntegration(IntegrationInterface $integration)

Sets the current integration.

setIntegration(string $name, string $version = '') deprecated

Set the integration name and version.

string
getApi()

Returns a string representation of the API currently in use.

Details

at line 33
ResourceInterface request(string $method, string $uri, array $options = [])

Sends a request to the API, and returns a resource object.

Parameters

string $method The HTTP method
string $uri The URI path
array $options An array of optional parameters. The following keys are accepted: * query An array of query parameters that will be appended to the URI * headers An array of headers that will be added to the request * body The request body * host A string that can be used to override the default client base URI

Return Value

ResourceInterface

Exceptions

RuntimeException

at line 41
useApplication(ApplicationInterface $application)

Sets the current application.

The values are used as part of the X-Contentful-User-Agent header.

Parameters

ApplicationInterface $application

at line 52
setApplication(string $name, string $version = '') deprecated

deprecated 2.2.0 Use useApplication instead

Set the application name and version.

The values are used as part of the X-Contentful-User-Agent header.

Parameters

string $name
string $version

at line 60
useIntegration(IntegrationInterface $integration)

Sets the current integration.

The values are used as part of the X-Contentful-User-Agent header.

Parameters

IntegrationInterface $integration

at line 71
setIntegration(string $name, string $version = '') deprecated

deprecated 2.2.0 Use useIntegration instead

Set the integration name and version.

The values are used as part of the X-Contentful-User-Agent header.

Parameters

string $name
string $version

at line 78
string getApi()

Returns a string representation of the API currently in use.

Return Value

string