\Pivot\Core\ReqResOutputGenerator

Output generator

Summary

Methods
Properties
Constants
__construct()
generate()
makeJsonOutput()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
generateJsonResponse()
makeProblemOutput()
generateNotAuthorised()
generateNotFound()
generateMethodNotAllowed()
$renderer
$develop
$verbose
N/A

Properties

$renderer

$renderer : \Pivot\Core\ReqRes\TwigRenderer

Output renderer

Type

\Pivot\Core\ReqRes\TwigRenderer

$develop

$develop : boolean

Is develop

Type

boolean

$verbose

$verbose : boolean

Is verbose Note: develop will over ride this (e.g. if we are not in develip mode we are not verbose)

Type

boolean

Methods

__construct()

__construct(  $renderer,   $develop = false,   $verbose = false) 

Parameters

$renderer
$develop
$verbose

generate()

generate(\Psr\Http\Message\ResponseInterface  $response, \Psr\Http\Message\RequestInterface  $request) : \Pivot\Core\ReqRes\output

Generates the output based on the $response class

Parameters

\Psr\Http\Message\ResponseInterface $response

Response from resource

\Psr\Http\Message\RequestInterface $request

Request that went to the resource

Returns

\Pivot\Core\ReqRes\output —

or void

makeJsonOutput()

makeJsonOutput(\Psr\Http\Message\ResponseInterface  $response, \Psr\Http\Message\RequestInterface  $request) : string

Makes JSON output based on status

Parameters

\Psr\Http\Message\ResponseInterface $response

Response from resource

\Psr\Http\Message\RequestInterface $request

Request that went to the resource

Returns

string —

json output

generateJsonResponse()

generateJsonResponse(\Psr\Http\Message\ResponseInterface  $response, \Psr\Http\Message\RequestInterface  $request) : \Pivot\Core\ReqRes\JSON

Generate a JSON response

Parameters

\Psr\Http\Message\ResponseInterface $response
\Psr\Http\Message\RequestInterface $request

Returns

\Pivot\Core\ReqRes\JSON —

string

makeProblemOutput()

makeProblemOutput(  $apiProblem, \Psr\Http\Message\RequestInterface  $request) 

Parameters

$apiProblem
\Psr\Http\Message\RequestInterface $request

generateNotAuthorised()

generateNotAuthorised(\Psr\Http\Message\ResponseInterface  $response, \Psr\Http\Message\RequestInterface  $request) : \Pivot\Core\ReqRes\output

generate Not Authorised response

Parameters

\Psr\Http\Message\ResponseInterface $response
\Psr\Http\Message\RequestInterface $request

Returns

\Pivot\Core\ReqRes\output

generateNotFound()

generateNotFound(\Psr\Http\Message\ResponseInterface  $response, \Psr\Http\Message\RequestInterface  $request) : \Pivot\Core\ReqRes\output

generate Not Found response

Parameters

\Psr\Http\Message\ResponseInterface $response
\Psr\Http\Message\RequestInterface $request

Returns

\Pivot\Core\ReqRes\output

generateMethodNotAllowed()

generateMethodNotAllowed(\Psr\Http\Message\ResponseInterface  $response, \Psr\Http\Message\RequestInterface  $request) : \Pivot\Core\ReqRes\[type]

generate Method Not Allowed

Parameters

\Psr\Http\Message\ResponseInterface $response
\Psr\Http\Message\RequestInterface $request

Returns

\Pivot\Core\ReqRes\[type]