GuzzleClient¶

class Firstred\PostNL\HttpClient\GuzzleClient¶

Class GuzzleClient.

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

Summary¶

Methods¶

public static getInstance()
public setOption($name, $value)
public getOption($name)
public setVerify($verify)
public getVerify()
public setMaxRetries($maxRetries)
public getMaxRetries()
public setConcurrency($concurrency)
public getConcurrency()
public setLogger($logger)
public getLogger()
public addOrUpdateRequest($id, $request)
public removeRequest($id)
public clearRequests()
public doRequest($request)
public doRequests($requests)

Constants¶

DEFAULT_TIMEOUT = 60

DEFAULT_CONNECT_TIMEOUT = 20

Properties¶

protected property Firstred\PostNL\HttpClient\GuzzleClient::$instance¶

Type: static

protected static property Firstred\PostNL\HttpClient\GuzzleClient::$defaultOptions¶

Type: array

protected static property Firstred\PostNL\HttpClient\GuzzleClient::$pendingRequests¶

List of pending PSR-7 requests.

Type: \Psr\Http\Message\RequestInterface[]

protected static property Firstred\PostNL\HttpClient\GuzzleClient::$logger¶

Type: \Psr\Log\LoggerInterface

Methods¶

public static Firstred\PostNL\HttpClient\GuzzleClient::getInstance()¶

Returns: \Firstred\PostNL\HttpClient\GuzzleClient | static
Deprecated: Please instantiate a new client rather than using this singleton

public Firstred\PostNL\HttpClient\GuzzleClient::setOption($name, $value)¶

Set Guzzle option.

Parameters

$name (string)
$value (mixed)

Returns

\Firstred\PostNL\HttpClient\GuzzleClient

public Firstred\PostNL\HttpClient\GuzzleClient::getOption($name)¶

Get Guzzle option.

Parameters

$name (string)

Returns

mixed | null

public Firstred\PostNL\HttpClient\GuzzleClient::setVerify($verify)¶

Set the verify setting.

Parameters

$verify (bool | string)

Returns

static

Deprecated

public Firstred\PostNL\HttpClient\GuzzleClient::getVerify()¶

Return verify setting.

Returns: bool | string
Deprecated

public Firstred\PostNL\HttpClient\GuzzleClient::setMaxRetries($maxRetries)¶

Set the amount of retries.

Parameters

$maxRetries (int)

Returns

static

public Firstred\PostNL\HttpClient\GuzzleClient::getMaxRetries()¶

Return max retries.

Returns: int

public Firstred\PostNL\HttpClient\GuzzleClient::setConcurrency($concurrency)¶

Set the concurrency.

Parameters

$concurrency (int)

Returns

static

public Firstred\PostNL\HttpClient\GuzzleClient::getConcurrency()¶

Return concurrency.

Returns: int

public Firstred\PostNL\HttpClient\GuzzleClient::setLogger($logger)¶

Set the logger.

Parameters

$logger (Psr\Log\LoggerInterface)

Returns

\Firstred\PostNL\HttpClient\GuzzleClient

public Firstred\PostNL\HttpClient\GuzzleClient::getLogger()¶

Get the logger.

Returns: \Psr\Log\LoggerInterface

public Firstred\PostNL\HttpClient\GuzzleClient::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\GuzzleClient::removeRequest($id)¶

Remove a request from the list of pending requests.

Parameters

$id (string)

public Firstred\PostNL\HttpClient\GuzzleClient::clearRequests()¶: Clear all pending requests.

public Firstred\PostNL\HttpClient\GuzzleClient::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\GuzzleClient::doRequests( $requests=\[\])¶

Do all async requests.

Exceptions are captured into the result array

Parameters

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

Returns

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