ProviderRedirectTrait
Table of Contents
Properties
- $redirectLimit : int
- Maximum number of times to follow provider initiated redirects
Methods
- getHttpClient() : ClientInterface
- Returns the HTTP client instance.
- getRedirectLimit() : int
- Retrieves current redirect limit.
- getResponse() : ResponseInterface
- Sends a request instance and returns a response instance.
- setRedirectLimit() : AbstractProvider
- Updates the redirect limit.
- followRequestRedirects() : ResponseInterface
- Retrieves a response for a given request and retrieves subsequent responses, with authorization headers, if a redirect is detected.
- isRedirect() : bool
- Determines if a given response is a redirect.
Properties
$redirectLimit
Maximum number of times to follow provider initiated redirects
protected
int
$redirectLimit
= 2
Methods
getHttpClient()
Returns the HTTP client instance.
public
abstract getHttpClient() : ClientInterface
Return values
ClientInterfacegetRedirectLimit()
Retrieves current redirect limit.
public
getRedirectLimit() : int
Return values
intgetResponse()
Sends a request instance and returns a response instance.
public
getResponse(RequestInterface $request) : ResponseInterface
WARNING: This method does not attempt to catch exceptions caused by HTTP errors! It is recommended to wrap this method in a try/catch block.
Parameters
- $request : RequestInterface
Return values
ResponseInterfacesetRedirectLimit()
Updates the redirect limit.
public
setRedirectLimit(int $limit) : AbstractProvider
Parameters
- $limit : int
Tags
Return values
AbstractProviderfollowRequestRedirects()
Retrieves a response for a given request and retrieves subsequent responses, with authorization headers, if a redirect is detected.
protected
followRequestRedirects(RequestInterface $request) : ResponseInterface
Parameters
- $request : RequestInterface
Tags
Return values
ResponseInterfaceisRedirect()
Determines if a given response is a redirect.
protected
isRedirect(ResponseInterface $response) : bool
Parameters
- $response : ResponseInterface