GuzzleHttp\RedirectMiddleware Class Reference

Public Member Functions
	__construct (callable $nextHandler)
	__invoke (RequestInterface $request, array $options)
	checkRedirect (RequestInterface $request, array $options, ResponseInterface $response)
	modifyRequest (RequestInterface $request, array $options, ResponseInterface $response)

Data Fields
const	HISTORY_HEADER = 'X-Guzzle-Redirect-History'
const	STATUS_HISTORY_HEADER = 'X-Guzzle-Redirect-Status-History'

Static Public Attributes
static	$defaultSettings

Detailed Description

Request redirect middleware.

Apply this middleware like other middleware using {

See also

\GuzzleHttp\Middleware::redirect()}.

Definition at line 18 of file RedirectMiddleware.php.

Constructor & Destructor Documentation

__construct()

GuzzleHttp\RedirectMiddleware::__construct

(

callable

$nextHandler

)

Parameters

callable

$nextHandler

Next handler to invoke.

Definition at line 41 of file RedirectMiddleware.php.

Member Function Documentation

__invoke()

GuzzleHttp\RedirectMiddleware::__invoke	(	RequestInterface	$request,
		array	$options
	)

Parameters

RequestInterface	$request
array	$options

Returns

PromiseInterface

Definition at line 52 of file RedirectMiddleware.php.

checkRedirect()

GuzzleHttp\RedirectMiddleware::checkRedirect	(	RequestInterface	$request,
		array	$options,
		ResponseInterface	$response
	)

Parameters

RequestInterface	$request
array	$options
ResponseInterface	$response

Returns

ResponseInterface|PromiseInterface

Definition at line 86 of file RedirectMiddleware.php.

References Psr\Http\Message\ResponseInterface\getStatusCode(), and Psr\Http\Message\MessageInterface\hasHeader().

modifyRequest()

GuzzleHttp\RedirectMiddleware::modifyRequest	(	RequestInterface	$request,
		array	$options,
		ResponseInterface	$response
	)

Parameters

RequestInterface	$request
array	$options
ResponseInterface	$response

Returns

RequestInterface

Definition at line 176 of file RedirectMiddleware.php.

References Psr\Http\Message\ResponseInterface\getStatusCode().

Field Documentation

$defaultSettings

GuzzleHttp\RedirectMiddleware::$defaultSettings

static

Initial value:

= [
        'max'             => 5,
        'protocols'       => ['http', 'https'],
        'strict'          => false,
        'referer'         => false,
        'track_redirects' => false,
    ]

Definition at line 24 of file RedirectMiddleware.php.

HISTORY_HEADER

const GuzzleHttp\RedirectMiddleware::HISTORY_HEADER = 'X-Guzzle-Redirect-History'

Definition at line 20 of file RedirectMiddleware.php.

STATUS_HISTORY_HEADER

const GuzzleHttp\RedirectMiddleware::STATUS_HISTORY_HEADER = 'X-Guzzle-Redirect-Status-History'

Definition at line 22 of file RedirectMiddleware.php.

---

The documentation for this class was generated from the following file:

• RedirectMiddleware.php