This package contains middleware for Guzzle that allows you to track redirects that happened during a request.
We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.
You can install the package via composer:
composer require spatie/guzzle-redirect-history-middlewareHere is a quick example of how you can use the Spatie\GuzzleRedirectHistoryMiddleware\RedirectHistoryMiddleware to store the redirect history in a Spatie\GuzzleRedirectHistoryMiddleware\RedirectHistory instance.
use Spatie\GuzzleRedirectHistoryMiddleware\RedirectHistory;
use Spatie\GuzzleRedirectHistoryMiddleware\RedirectHistoryMiddleware;
/*
* First create a new instance of `RedirectHistory`
* This instance can be used after the requests to get the redirects.
*/
$redirectHistory = new RedirectHistory();
/*
* This is the default way to add a middleware to Guzzle
* default middleware stack.
*/
$stack = HandlerStack::create();
$stack->push(RedirectHistoryMiddleware::make($redirectHistory));
/*
* Let's create Guzzle client that uses the middleware stack
* containing our `RedirectHistoryMiddleware`.
*/
$client = new Client([
'handler' => $stack,
]);
/*
* Now, let's make a request.
*/
$response = $client->get($anyUrl);
/*
* And tada, here are all the redirects performed
* during the request.
*/
$redirects = $redirectHistory->toArray();$redirects is an array of which item is an array with these keys:
status: the status code of the responseurl: the URL of the performed request that resulted in a redirect
So if you make a request to https://example.com/page-a which redirects to /page-b which finally redirects to /page-c, this will be the content of $redirects
[
['status' => 302, 'url' => 'https://example.com/page-a'],
['status' => 302, 'url' => 'https://example.com/page-b'],
['status' => 200, 'url' => 'https://example.com/page-c'],
];Even if your initial request results in a \GuzzleHttp\Exception\TooManyRedirectsException, the RedirectHistory will still contain the performed redirects
Guzzle has built-in support for tracking redirects. Unfortunately, it isn't that developer friendly to use. You'll have to manipulate and combine arrays found in the X-Guzzle-Redirect-History and X-Guzzle-Redirect-Status-History headers.
Also, when hitting an exception such as TooManyRedirectsException, these headers won't be filled.
Our package makes it easy to retrieve the redirects in a sane format. You're also able to get the redirect history even if the request ultimately fails.
composer testPlease see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
Please review our security policy on how to report security vulnerabilities.
The MIT License (MIT). Please see License File for more information.