Rescuer

A pretty basic contingency plan.

class Rescuer implements Plugin

Under normal circumstances, this class will simply return the response given by the $next function. In the event that an Exception occurred in the $next function, this class will craft a new response containing details about the error itself.

Copyright: 2015-2016 Appertly

License: Apache-2.0

Instance Properties

Protected
Name	Type	Summary
`$debug`	`bool`	Whether to include exception information in responses
`$xhpClass`	`string`	The class name of the XHP to render

Static Properties

Protected
Name	Type	Summary
`$messages`	`ImmMap`<`int`,`string`>	Convenient map of HTTP status codes to human-readable explanations

Constructors / Destructors

Public
Returns	Signature and Description
`void`	`__construct`(`ConstMap<string,mixed> $options = ImmMap{}`) Creates a new Contingency.

Instance Methods

Public
Returns	Signature and Description
`ResponseInterface`	`__invoke`(`ServerRequestInterface $request`, `ResponseInterface $response`, `(function(Request,Response):Response) $next`) Middleware request–response handling.
`int`	`getPriority`() Gets the plugin priority; larger means first.
`ResponseInterface`	`process`(`ServerRequestInterface $request`, `ResponseInterface $response`, `Exception $e`) Handles an exception.

Protected
Returns	Signature and Description
`Map`<`string`,`mixed`>	`getValues`(`ServerRequestInterface $request`, `Exception $e`) Assembles the values from the Request and Exception.
`XHPRoot`	`renderHtml`(`Map<string,mixed> $values`) Returns the XHP to render.
`ProblemDetails`	`renderJson`(`Map<string,mixed> $values`) Returns the ProblemDetails to render.

Property Details

$debug

protected bool $debug

Whether to include exception information in responses

$messages

static protected ImmMap<int,string> $messages

Convenient map of HTTP status codes to human-readable explanations

$xhpClass

protected string $xhpClass

The class name of the XHP to render

Method Details

__construct

public function __construct(ConstMap<string,mixed> $options = ImmMap{})

Creates a new Contingency.

The following options are available:

debug – Whether to include exception stack trace information (should be false in production!). Defaults to false.
xhpClass – The class name of XHP to render (must be xhp_class_name format). Defaults to xhp__labrys__error_page.

Parameters
Name	Type	Description
`$options`	`ConstMap`<`string`,`mixed`>	The options

__invoke

public function __invoke(ServerRequestInterface $request, ResponseInterface $response, (function(Request,Response):Response) $next)

Middleware request–response handling.

Parameters
Name	Type	Description
`$request`	`ServerRequestInterface`	The server request
`$response`	`ResponseInterface`	The response
`$next`	`(function(Request,Response):Response)`

Returns
Type	Description
`ResponseInterface`	The response

getPriority

public function getPriority()

Gets the plugin priority; larger means first.

Returns
Type	Description
`int`	The plugin priority

getValues

protected function getValues(ServerRequestInterface $request, Exception $e)

Assembles the values from the Request and Exception.

Parameters
Name	Type	Description
`$request`	`ServerRequestInterface`	The request
`$e`	`Exception`	The Exception

Returns
Type	Description
`Map`<`string`,`mixed`>	The assembled values

process

public function process(ServerRequestInterface $request, ResponseInterface $response, Exception $e)

Handles an exception.

This is your chance for logging, changing the HTTP status header, and rendering some kind of message for the client.

Parameters
Name	Type	Description
`$request`	`ServerRequestInterface`	The request
`$response`	`ResponseInterface`	The response
`$e`	`Exception`	The exception to process

Returns
Type	Description
`ResponseInterface`	The new response

renderHtml

protected function renderHtml(Map<string,mixed> $values)

Returns the XHP to render.

Parameters
Name	Type	Description
`$values`	`Map`<`string`,`mixed`>	The values

Returns
Type	Description
`XHPRoot`	The HTML response

renderJson

protected function renderJson(Map<string,mixed> $values)

Returns the ProblemDetails to render.

Parameters
Name	Type	Description
`$values`	`Map`<`string`,`mixed`>	The values

Returns
Type	Description
`ProblemDetails`	The JSON response