Matching
in package
implements
Authentication
FinalYes
Authenticate a PSR-7 Request if the request is matching.
Tags
Table of Contents
Interfaces
- Authentication
- Add authentication information to a PSR-7 Request.
Properties
Methods
- __construct() : mixed
- authenticate() : RequestInterface
- Alter the request to add the authentication credentials.
- createUrlMatcher() : self
- Creates a matching authentication for an URL.
Properties
$authentication
private
Authentication
$authentication
$matcher
private
CallbackRequestMatcher
$matcher
Methods
__construct()
public
__construct(Authentication $authentication[, callable|null $matcher = null ]) : mixed
Parameters
- $authentication : Authentication
- $matcher : callable|null = null
authenticate()
Alter the request to add the authentication credentials.
public
authenticate(RequestInterface $request) : RequestInterface
To do that, the implementation might use pre-stored credentials or do separate HTTP requests to obtain a valid token.
Parameters
- $request : RequestInterface
-
The request without authentication information
Return values
RequestInterface —The request with added authentication information
createUrlMatcher()
Creates a matching authentication for an URL.
public
static createUrlMatcher(Authentication $authentication, string $url) : self
Parameters
- $authentication : Authentication
- $url : string