UserFrosting API

JsonRenderer extends ErrorRenderer

Default JSON Error Renderer.

Table of Contents

$request ServerRequestInterface
$response ResponseInterface
$exception Throwable
$displayErrorDetails Tells the renderer whether or not to output detailed error information to the client. bool
render() string
formatExceptionPayload() string
formatExceptionFragment() array
__construct() Create a new ErrorRenderer object. mixed
render() string
renderWithBody() Body

Properties

$displayErrorDetails

Tells the renderer whether or not to output detailed error information to the client.

protected bool $displayErrorDetails
Each renderer may choose if and how to implement this.

Methods

formatExceptionPayload()

public formatExceptionPayload( $message : string ) : string
Parameters
$message : string
Return values
string

formatExceptionFragment()

public formatExceptionFragment( $e : Exception|Throwable ) : array
Parameters
$e : Exception|Throwable
Return values
array

__construct()

Create a new ErrorRenderer object.

public __construct( $request : ServerRequestInterface , $response : ResponseInterface , $exception : Throwable [, $displayErrorDetails : bool = false ] ) : mixed
Parameters
$request : ServerRequestInterface

The most recent Request object

$response : ResponseInterface

The most recent Response object

$exception : Throwable

The caught Exception object

$displayErrorDetails : bool = false
Return values
mixed

render()

public abstract render( ) : string
Return values
string

renderWithBody()

public renderWithBody( ) : Body
Return values
Body

Search results