Http\Message\Authentication\QueryParam Class Reference
Inheritance diagram for Http\Message\Authentication\QueryParam:
Public Member Functions | |
| __construct (array $params) | |
| authenticate (RequestInterface $request) | |
Detailed Description
Authenticate a PSR-7 Request by adding parameters to its query.
Note: Although in some cases it can be useful, we do not recommend using query parameters for authentication. Credentials in the URL is generally unsafe as they are not encrypted, anyone can see them.
Definition at line 16 of file QueryParam.php.
Constructor & Destructor Documentation
◆ __construct()
| Http\Message\Authentication\QueryParam::__construct | ( | array | $params | ) |
- Parameters
-
array $params
Definition at line 29 of file QueryParam.php.
Member Function Documentation
◆ authenticate()
| Http\Message\Authentication\QueryParam::authenticate | ( | RequestInterface | $request | ) |
{Alter the request to add the authentication credentials.To do that, the implementation might use pre-stored credentials or do separate HTTP requests to obtain a valid token.
- Parameters
-
RequestInterface $request The request without authentication information
- Returns
- RequestInterface The request with added authentication information
Implements Http\Message\Authentication.
Definition at line 37 of file QueryParam.php.
References Psr\Http\Message\RequestInterface\getUri(), and Psr\Http\Message\RequestInterface\withUri().
The documentation for this class was generated from the following file:
