HTTPlugClient

class Firstred\PostNL\HttpClient\HTTPlugClient

Class HTTPlugClient.

Implements

Firstred\PostNL\HttpClient\ClientInterface

Summary

Methods

• public __construct($client, $logger, $concurrency)

• public addOrUpdateRequest($id, $request)

• public removeRequest($id)

• public doRequests($requests)

• public clearRequests()

• public doRequest($request)

• public getConcurrency()

• public setConcurrency($concurrency)

• public getLogger()

• public setLogger($logger)

• public getClient()

• public setClient($client)

• public static getInstance($client)

• public setVerify($verify)

• public getVerify()

Properties

protected static property Firstred\PostNL\HttpClient\HTTPlugClient::$client

Type

\Http\Client\HttpAsyncClient | \Http\Client\HttpClient

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

List of pending PSR-7 requests.

Type

\Psr\Http\Message\RequestInterface[]

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

Type

\Psr\Log\LoggerInterface | null

protected static property Firstred\PostNL\HttpClient\HTTPlugClient::$concurrency

Type

int

Methods

public Firstred\PostNL\HttpClient\HTTPlugClient::__construct($client=null, $logger=null, $concurrency=5)

HTTPlugClient constructor.

Parameters

• $client (Http\Client\HttpAsyncClient | \Http\Client\HttpClient | null)

• $logger (Psr\Log\LoggerInterface | null)

• $concurrency (int)

Throws

\Firstred\PostNL\Exception\HttpClientException

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

Adds a request to the list of pending requests

Using the ID you can replace a request.

Parameters

• $id (string)

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

Returns

string

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

Remove a request from the list of pending requests.

Parameters

• $id (string)

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

Do all async requests.

Exceptions are captured into the result array

Parameters

• $requests (array)

Returns

array

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

Clear all pending requests.

public Firstred\PostNL\HttpClient\HTTPlugClient::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\HTTPlugClient::getConcurrency()

Returns

int

public Firstred\PostNL\HttpClient\HTTPlugClient::setConcurrency($concurrency)

Parameters

• $concurrency (int)

Returns

static

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

Returns

\Psr\Log\LoggerInterface | null

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

Parameters

• $logger (Psr\Log\LoggerInterface | null)

Returns

static

public Firstred\PostNL\HttpClient\HTTPlugClient::getClient()

Returns

\Http\Client\HttpAsyncClient | \Http\Client\HttpClient

public Firstred\PostNL\HttpClient\HTTPlugClient::setClient($client)

Parameters

• $client (Http\Client\HttpAsyncClient | \Http\Client\HttpClient)

Returns

static

public static Firstred\PostNL\HttpClient\HTTPlugClient::getInstance($client=null)

Parameters

• $client (Http\Client\HttpAsyncClient | \Http\Client\HttpClient | null)

Returns

\Firstred\PostNL\HttpClient\HTTPlugClient

Throws

\Firstred\PostNL\Exception\HttpClientException

Deprecated

Please instantiate a new client rather than using this singleton

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

Parameters

• $verify (bool | string)

Returns

\Firstred\PostNL\HttpClient\HTTPlugClient

Deprecated

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

Returns

bool | string | void

Deprecated