Controller
in package
AbstractYes
Base class to inherit your controllers from
Tags
Table of Contents
Properties
- $appName : string
- app name
- $request : IRequest
- current request
- $responders : array<string|int, mixed>
Methods
- __construct() : mixed
- constructor of the controller
- buildResponse() : Response
- Serializes and formats a response
- getResponderByHTTPHeader() : string
- Parses an HTTP accept header and returns the supported responder type
- registerResponder() : mixed
- Registers a formatter for a type
Properties
$appName
app name
protected
string
$appName
Tags
$request
current request
protected
IRequest
$request
Tags
$responders
private
array<string|int, mixed>
$responders
Tags
Methods
__construct()
constructor of the controller
public
__construct(string $appName, IRequest $request) : mixed
Parameters
- $appName : string
-
the name of the app
- $request : IRequest
-
an instance of the request
Tags
buildResponse()
Serializes and formats a response
public
buildResponse(mixed $response[, string $format = 'json' ]) : Response
Parameters
- $response : mixed
-
the value that was returned from a controller and is not a Response instance
- $format : string = 'json'
-
the format for which a formatter has been registered
Tags
Return values
ResponsegetResponderByHTTPHeader()
Parses an HTTP accept header and returns the supported responder type
public
getResponderByHTTPHeader(string $acceptHeader[, string $default = 'json' ]) : string
Parameters
- $acceptHeader : string
- $default : string = 'json'
Tags
Return values
string —the responder type
registerResponder()
Registers a formatter for a type
protected
registerResponder(string $format, Closure $responder) : mixed
Parameters
- $format : string
- $responder : Closure