TraceableHttpClient
in package
implements
HttpClientInterface, ResetInterface, LoggerAwareInterface
FinalYes
Tags
Table of Contents
Interfaces
- HttpClientInterface
- Provides flexible methods for requesting HTTP resources synchronously or asynchronously.
- ResetInterface
- Provides a way to reset an object to its initial state.
- LoggerAwareInterface
- Describes a logger-aware instance.
Properties
- $client : mixed
- $stopwatch : mixed
- $tracedRequests : ArrayObject
Methods
- __construct() : mixed
- getTracedRequests() : array<string|int, mixed>
- request() : ResponseInterface
- Requests an HTTP resource.
- reset() : mixed
- setLogger() : void
- Sets a logger instance on the object.
- stream() : ResponseStreamInterface
- Yields responses chunk by chunk as they complete.
- withOptions() : static
- Returns a new instance of the client with new default options.
Properties
$client
private
mixed
$client
$stopwatch
private
mixed
$stopwatch
$tracedRequests
private
ArrayObject
$tracedRequests
Methods
__construct()
public
__construct(HttpClientInterface $client[, Stopwatch $stopwatch = null ]) : mixed
Parameters
- $client : HttpClientInterface
- $stopwatch : Stopwatch = null
getTracedRequests()
public
getTracedRequests() : array<string|int, mixed>
Return values
array<string|int, mixed>request()
Requests an HTTP resource.
public
request(string $method, string $url[, array<string|int, mixed> $options = [] ]) : ResponseInterface
Parameters
- $method : string
- $url : string
- $options : array<string|int, mixed> = []
Return values
ResponseInterfacereset()
public
reset() : mixed
setLogger()
Sets a logger instance on the object.
public
setLogger(LoggerInterface $logger) : void
Parameters
- $logger : LoggerInterface
stream()
Yields responses chunk by chunk as they complete.
public
stream(ResponseInterface|iterable<string|int, mixed> $responses[, float $timeout = null ]) : ResponseStreamInterface
Parameters
- $responses : ResponseInterface|iterable<string|int, mixed>
-
One or more responses created by the current HTTP client
- $timeout : float = null
-
The idle timeout before yielding timeout chunks
Return values
ResponseStreamInterfacewithOptions()
Returns a new instance of the client with new default options.
public
withOptions(array<string|int, mixed> $options) : static
Parameters
- $options : array<string|int, mixed>