BaseRequestHandler
in package
The base class for request handlers.
Table of Contents
Methods
- __construct() : mixed
- Constructor with an implementation of the AuthleteApi interface.
- getApi() : AuthleteApi
- Get the implementation of the AuthleteApi interface.
- unknownAction() : Response
- A utility method to generate a Response instance with "500 Internal Server Error" and an error message in JSON.
Methods
__construct()
Constructor with an implementation of the AuthleteApi interface.
public
__construct(AuthleteApi $api) : mixed
The given value can be obtained later by calling getApi() method.
Parameters
- $api : AuthleteApi
-
An implementation of the
AuthleteApiinterface.
getApi()
Get the implementation of the AuthleteApi interface.
public
getApi() : AuthleteApi
The value returned from this method is the instance that was given to the constructor.
Return values
AuthleteApi —An implementation of the AuthleteApi interface.
unknownAction()
A utility method to generate a Response instance with "500 Internal Server Error" and an error message in JSON.
protected
unknownAction(string $apiPath) : Response
This method is expected to be used when the value of the action
parameter in a response from an Authlete API holds an unexpected
value.
Parameters
- $apiPath : string
-
The path of an Authlete API.
Return values
Response —A Response instahce which represents a server error.