1. class
  2. Contentful
  3. \
  4. Client

Client

class Client

Abstract client for common code for the different clients.

Methods

__construct(string $token, string $baseUri, string $api, LoggerInterface $logger = null, ClientInterface $guzzle = null)

Client constructor.

$this
setApplication(string|null $name, string|null $version = null)

Set the application name and version. The values are used as part of the X-Contentful-User-Agent header.

$this
setIntegration(string|null $name, string|null $version = null)

Set the integration name and version. The values are used as part of the X-Contentful-User-Agent header.

array|null
request(string $method, string $path, array $options = [])

No description

string[]
getExceptionMap()

No description

LoggerInterface
getLogger()

No description

string
getSdkName()

The name of the library to be used in the User-Agent header.

string
getSdkVersion()

The version of the library to be used in the User-Agent header.

string
getApiContentType()

Returns the Content-Type (MIME-Type) to be used when communication with the API.

Details

at line 65
__construct(string $token, string $baseUri, string $api, LoggerInterface $logger = null, ClientInterface $guzzle = null)

Client constructor.

Parameters

string $token
string $baseUri
string $api
LoggerInterface $logger
ClientInterface $guzzle

at line 84
$this setApplication(string|null $name, string|null $version = null)

Set the application name and version. The values are used as part of the X-Contentful-User-Agent header.

Parameters

string|null $name
string|null $version

Return Value

$this

at line 99
$this setIntegration(string|null $name, string|null $version = null)

Set the integration name and version. The values are used as part of the X-Contentful-User-Agent header.

Parameters

string|null $name
string|null $version

Return Value

$this

at line 117
protected array|null request(string $method, string $path, array $options = [])

Parameters

string $method The HTTP method
string $path 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 * additionalHeaders An array of headers that will be added to the request * body The request body * baseUri A string that can be used to override the default client base URI

Return Value

array|null

at line 233
protected string[] getExceptionMap()

Return Value

string[]

at line 247
LoggerInterface getLogger()

Return Value

LoggerInterface

at line 257
abstract protected string getSdkName()

The name of the library to be used in the User-Agent header.

Return Value

string

at line 264
abstract protected string getSdkVersion()

The version of the library to be used in the User-Agent header.

Return Value

string

at line 271
abstract protected string getApiContentType()

Returns the Content-Type (MIME-Type) to be used when communication with the API.

Return Value

string