Inheritance diagram for Samy\SimpleApi\RequestInterface:
Public Member Functions | |
| hasAuthorization () | |
| getAuthorization () | |
| getAuthType () | |
| withAuthType (string $AuthType) | |
| getCredentials () | |
| withCredentials (string $Credentials) | |
Detailed Description
Describes SimpleApi Request interface.
Member Function Documentation
◆ getAuthorization()
| Samy\SimpleApi\RequestInterface::getAuthorization | ( | ) |
Return an instance with provided authorization header.
- Returns
- string
◆ getAuthType()
| Samy\SimpleApi\RequestInterface::getAuthType | ( | ) |
Retrieve provided authorization type.
- Returns
- string
◆ getCredentials()
| Samy\SimpleApi\RequestInterface::getCredentials | ( | ) |
Retrieve provided authorization credentials.
- Returns
- string
◆ hasAuthorization()
| Samy\SimpleApi\RequestInterface::hasAuthorization | ( | ) |
Checks if a has authorization header.
- Returns
- bool
◆ withAuthType()
| Samy\SimpleApi\RequestInterface::withAuthType | ( | string | $AuthType | ) |
Return an instance with provided authorization type.
- Parameters
-
[in] string $AuthType Authorization type
- Returns
- static
◆ withCredentials()
| Samy\SimpleApi\RequestInterface::withCredentials | ( | string | $Credentials | ) |
Return an instance with provided authorization credentials.
- Parameters
-
[in] string $Credentials Authorization credentials
- Returns
- static
The documentation for this interface was generated from the following file:
- simpleapi/RequestInterface.php
