CurlClient

class Firstred\PostNL\HttpClient\CurlClient

Class CurlClient.

Implements

Firstred\PostNL\HttpClient\ClientInterface Psr\Log\LoggerAwareInterface

Summary

Methods

• public static getInstance()

• public setTimeout($seconds)

• public setConnectTimeout($seconds)

• public setVerify($verify)

• public setLogger($logger)

• public getTimeout()

• public getConnectTimeout()

• public getVerify()

• public getLogger()

• public addOrUpdateRequest($id, $request)

• public removeRequest($id)

• public clearRequests()

• public doRequest($request)

• public doRequests($requests)

• protected prepareRequest($curl, $request)

Constants

DEFAULT_TIMEOUT = 80

DEFAULT_CONNECT_TIMEOUT = 30

Properties

protected static property Firstred\PostNL\HttpClient\CurlClient::$defaultOptions

Type

array | callable | null

protected static property Firstred\PostNL\HttpClient\CurlClient::$userAgentInfo

Type

array

protected static property Firstred\PostNL\HttpClient\CurlClient::$pendingRequests

Type

array

protected static property Firstred\PostNL\HttpClient\CurlClient::$logger

Type

\Psr\Log\LoggerInterface

Methods

public static Firstred\PostNL\HttpClient\CurlClient::getInstance()

CurlClient Singleton.

Returns

\Firstred\PostNL\HttpClient\CurlClient

Deprecated

Please instantiate a new client rather than using this singleton

public Firstred\PostNL\HttpClient\CurlClient::setTimeout($seconds)

Set timeout.

Parameters

• $seconds (int)

Returns

\Firstred\PostNL\HttpClient\CurlClient

public Firstred\PostNL\HttpClient\CurlClient::setConnectTimeout($seconds)

Set connection timeout.

Parameters

• $seconds (int)

Returns

\Firstred\PostNL\HttpClient\CurlClient

public Firstred\PostNL\HttpClient\CurlClient::setVerify($verify)

Set the verify setting.

Parameters

• $verify (bool | string)

Returns

\Firstred\PostNL\HttpClient\CurlClient

Deprecated

public Firstred\PostNL\HttpClient\CurlClient::setLogger($logger)

Set the logger.

Parameters

• $logger (Psr\Log\LoggerInterface)

Returns

\Firstred\PostNL\HttpClient\CurlClient

public Firstred\PostNL\HttpClient\CurlClient::getTimeout()

Get timeout.

Returns

int

public Firstred\PostNL\HttpClient\CurlClient::getConnectTimeout()

Get connection timeout.

Returns

int

public Firstred\PostNL\HttpClient\CurlClient::getVerify()

Return verify setting.

Returns

bool | string

Deprecated

public Firstred\PostNL\HttpClient\CurlClient::getLogger()

Get logger.

Returns

\Psr\Log\LoggerInterface

public Firstred\PostNL\HttpClient\CurlClient::addOrUpdateRequest($id, $request)

Adds a request to the list of pending requests

Using the ID you can replace a request.

Parameters

• $id (string) Request ID

• $request (Psr\Http\Message\RequestInterface) PSR-7 request

Returns

int | string

public Firstred\PostNL\HttpClient\CurlClient::removeRequest($id)

Remove a request from the list of pending requests.

Parameters

• $id (string)

public Firstred\PostNL\HttpClient\CurlClient::clearRequests()

Clear all pending requests.

public Firstred\PostNL\HttpClient\CurlClient::doRequest($request)

Do a single request.

Exceptions are captured into the result array

Parameters

• $request (Psr\Http\Message\RequestInterface)

Returns

\Psr\Http\Message\ResponseInterface

Throws

\Firstred\PostNL\Exception\HttpClientException

public Firstred\PostNL\HttpClient\CurlClient::doRequests( $requests=\[\])

Do all async requests.

Exceptions are captured into the result array

Parameters

• $requests (Psr\Http\Message\RequestInterface[])

Returns

\Psr\Http\Message\ResponseInterface[] | \Firstred\PostNL\Exception\HttpClientException[]

protected Firstred\PostNL\HttpClient\CurlClient::prepareRequest($curl, $request)

Parameters

• $curl (resource)

• $request (Psr\Http\Message\RequestInterface)

Throws

\Firstred\PostNL\Exception\HttpClientException