ClientInterface¶

interface Firstred\PostNL\HttpClient\ClientInterface¶: Interface ClientInterface.

Summary¶

Methods¶

public getLogger()
public setLogger($logger)
public static getInstance()
public addOrUpdateRequest($id, $request)
public setVerify($verify)
public getVerify()
public removeRequest($id)
public clearRequests()
public doRequest($request)
public doRequests($requests)

Methods¶

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

Get the logger.

Returns: \Psr\Log\LoggerInterface

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

Set the logger.

Parameters

$logger (Psr\Log\LoggerInterface)

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

Get the HTTP Client instance.

Returns: static

public Firstred\PostNL\HttpClient\ClientInterface::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\ClientInterface::setVerify($verify)¶

Set the verify setting.

Parameters

$verify (bool | string)

Returns

static

Deprecated

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

Return verify setting.

Returns: bool | string
Deprecated

public Firstred\PostNL\HttpClient\ClientInterface::removeRequest($id)¶

Remove a request from the list of pending requests.

Parameters

$id (string)

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

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

Do all async requests.

Exceptions are captured into the result array

Parameters

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

Returns

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