BaseUriPlugin
in package
implements
Plugin
FinalYes
Combines the AddHostPlugin and AddPathPlugin.
Tags
Table of Contents
Interfaces
- Plugin
- A plugin is a middleware to transform the request and/or the response.
Properties
Methods
- __construct() : mixed
- handleRequest() : Promise
- Handle the request and return the response coming from the next callable.
Properties
$addHostPlugin
private
AddHostPlugin
$addHostPlugin
$addPathPlugin
private
AddPathPlugin|null
$addPathPlugin
= null
Methods
__construct()
public
__construct(UriInterface $uri[, array<string|int, mixed> $hostConfig = [] ]) : mixed
Parameters
- $uri : UriInterface
-
Has to contain a host name and can have a path
- $hostConfig : array<string|int, mixed> = []
-
Config for AddHostPlugin. @see AddHostPlugin::configureOptions
handleRequest()
Handle the request and return the response coming from the next callable.
public
handleRequest(RequestInterface $request, callable $next, callable $first) : Promise
Parameters
- $request : RequestInterface
- $next : callable
-
Next middleware in the chain, the request is passed as the first argument
- $first : callable
-
First middleware in the chain, used to to restart a request
Return values
Promise —Resolves a PSR-7 Response or fails with an Http\Client\Exception (The same as HttpAsyncClient)