Functions used to create and wrap handlers with handler middleware.
- Full name:
\GuzzleHttp\Middleware - This class is marked as final and can't be subclassed
- This class is a Final class
Middleware that adds cookies to requests.
public static cookies(): callableThe options array must be set to a CookieJarInterface in order to use cookies. This is typically handled for you by a client.
- This method is static.
Return Value:
Returns a function that accepts the next handler.
Middleware that throws exceptions for 4xx or 5xx responses when the "http_errors" request option is set to true.
public static httpErrors(\GuzzleHttp\BodySummarizerInterface|null $bodySummarizer = null): callable- This method is static.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$bodySummarizer |
\GuzzleHttp\BodySummarizerInterface|null | The body summarizer to use in exception messages. |
Middleware that pushes history data to an ArrayAccess container.
public static history(array|\ArrayAccess<int,array>& $container): callable- This method is static.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$container |
array|\ArrayAccess<int,array> | Container to hold the history (by reference). |
Middleware that invokes a callback before and after sending a request.
public static tap(callable $before = null, callable $after = null): callableThe provided listener cannot modify or alter the response. It simply "taps" into the chain to be notified before returning the promise. The before listener accepts a request and options array, and the after listener accepts a request, options array, and response promise.
- This method is static.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$before |
callable | Function to invoke before forwarding the request. |
$after |
callable | Function invoked after forwarding. |
Return Value:
Returns a function that accepts the next handler.
Middleware that handles request redirects.
public static redirect(): callable- This method is static.
Return Value:
Returns a function that accepts the next handler.
Middleware that retries requests based on the boolean result of invoking the provided "decider" function.
public static retry(callable $decider, callable $delay = null): callableIf no delay function is provided, a simple implementation of exponential backoff will be utilized.
- This method is static.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$decider |
callable | Function that accepts the number of retries, a request, [response], and [exception] and returns true if the request is to be retried. |
$delay |
callable | Function that accepts the number of retries and returns the number of milliseconds to delay. |
Return Value:
Returns a function that accepts the next handler.
Middleware that logs requests, responses, and errors using a message formatter.
public static log(\Psr\Log\LoggerInterface $logger, \GuzzleHttp\MessageFormatterInterface|\GuzzleHttp\MessageFormatter $formatter, string $logLevel = 'info'): callable- This method is static.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$logger |
\Psr\Log\LoggerInterface | Logs messages. |
$formatter |
\GuzzleHttp\MessageFormatterInterface|\GuzzleHttp\MessageFormatter | Formatter used to create message strings. |
$logLevel |
string | Level at which to log requests. |
Return Value:
Returns a function that accepts the next handler.
This middleware adds a default content-type if possible, a default content-length or transfer-encoding header, and the expect header.
public static prepareBody(): callable- This method is static.
Middleware that applies a map function to the request before passing to the next handler.
public static mapRequest(callable $fn): callable- This method is static.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$fn |
callable | Function that accepts a RequestInterface and returns a RequestInterface. |
Middleware that applies a map function to the resolved promise's response.
public static mapResponse(callable $fn): callable- This method is static.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$fn |
callable | Function that accepts a ResponseInterface and returns a ResponseInterface. |