Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spatie/guzzle-redirect-history-middleware
A Guzzle middleware to keep track of redirects
https://github.com/spatie/guzzle-redirect-history-middleware
guzzle http middleware php redirect
Last synced: about 1 month ago
JSON representation
A Guzzle middleware to keep track of redirects
- Host: GitHub
- URL: https://github.com/spatie/guzzle-redirect-history-middleware
- Owner: spatie
- License: mit
- Created: 2021-10-06T07:46:49.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-08-25T11:00:27.000Z (over 2 years ago)
- Last Synced: 2024-10-04T12:47:51.426Z (3 months ago)
- Topics: guzzle, http, middleware, php, redirect
- Language: PHP
- Homepage: https://spatie.be/open-source
- Size: 42 KB
- Stars: 18
- Watchers: 5
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
[
](https://supportukrainenow.org)
# A Guzzle middleware to keep track of redirects
[](https://packagist.org/packages/spatie/guzzle-redirect-history-middleware)
[](https://github.com/spatie/guzzle-redirect-history-middleware/actions/workflows/run-tests.yml)
[](https://github.com/spatie/guzzle-redirect-history-middleware/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amaster)
[](https://packagist.org/packages/spatie/guzzle-redirect-history-middleware)
This package contains middleware for [Guzzle](https://docs.guzzlephp.org/en/stable/) that allows you to track redirects that happened during a request.
## Support us
[
](https://spatie.be/github-ad-click/guzzle-redirect-history-middleware)
We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
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](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
## Installation
You can install the package via composer:
```bash
composer require spatie/guzzle-redirect-history-middleware
```
## Usage
Here is a quick example of how you can use the `Spatie\GuzzleRedirectHistoryMiddleware\RedirectHistoryMiddleware` to store the redirect history in a `Spatie\GuzzleRedirectHistoryMiddleware\RedirectHistory` instance.
```php
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 response
- `url`: 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`
```php
[
['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
## Why we created this package
Guzzle has [built-in support for tracking redirects](https://docs.guzzlephp.org/en/stable/request-options.html#allow-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.
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Freek Van der Herten](https://github.com/freekmurze)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.