MessageHelper

Controller trait with some handy methods.

trait MessageHelper

Instance Methods

Protected
Returns	Signature and Description
`Map`<`string`,`mixed`>	`getParsedBodyMap`(`ServerRequestInterface $request`) Gets a `Map` of the request body content.
`Principal`	`getPrincipal`(`ServerRequestInterface $request`) Gets the stored principal, or the anonymous user if none was found.
`Map`<`string`,`mixed`>	`getQueryParamsMap`(`ServerRequestInterface $request`) Gets a `Map` of the request query params.
`ResponseInterface`	`ifModSince`(`ServerRequestInterface $request`, `ResponseInterface $response`, `int $timestamp`) Checks the `If-Modified-Since` header, maybe sending 304 Not Modified.
`ResponseInterface`	`ifNoneMatch`(`ServerRequestInterface $request`, `ResponseInterface $response`, `string $etag`) Checks the `If-None-Match` header, maybe sending 304 Not Modified.
`PaginationFactory`	`paginationFactory`() Gets a pagination factory
`ResponseInterface`	`redirect`(`ResponseInterface $response`, `int $code`, `string $url`) Redirects the user to another URL.
`ResponseInterface`	`write`(`ResponseInterface $response`, `mixed $body`) Cleanly writes the body to the response.

protected function getParsedBodyMap(ServerRequestInterface $request)

Gets a Map of the request body content.

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

Returns
Type	Description
`Map`<`string`,`mixed`>	The Map of request body content

protected function getPrincipal(ServerRequestInterface $request)

Gets the stored principal, or the anonymous user if none was found.

Parameters
Name	Type	Description
`$request`	`ServerRequestInterface`	The HTTP request

Returns
Type	Description
`Principal`	The authenticated principal

protected function getQueryParamsMap(ServerRequestInterface $request)

Gets a Map of the request query params.

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

Returns
Type	Description
`Map`<`string`,`mixed`>	The Map of query params

protected function ifModSince(ServerRequestInterface $request, ResponseInterface $response, int $timestamp)

Checks the If-Modified-Since header, maybe sending 304 Not Modified.

Parameters
Name	Type	Description
`$request`	`ServerRequestInterface`	The HTTP request
`$response`	`ResponseInterface`	The HTTP response
`$timestamp`	`int`	The timestamp for comparison

Returns
Type	Description
`ResponseInterface`	The same or new response

protected function ifNoneMatch(ServerRequestInterface $request, ResponseInterface $response, string $etag)

Checks the If-None-Match header, maybe sending 304 Not Modified.

Returns
Type	Description
`ResponseInterface`	The same or new response

protected function paginationFactory()

Gets a pagination factory

Returns
Type	Description
`PaginationFactory`	The pagination factory

protected function redirect(ResponseInterface $response, int $code, string $url)

Redirects the user to another URL.

Returns
Type	Description
`ResponseInterface`	The new response

protected function write(ResponseInterface $response, mixed $body)

Cleanly writes the body to the response.

Parameters
Name	Type	Description
`$response`	`ResponseInterface`	The HTTP response
`$body`	`mixed`	The body to write

Returns
Type	Description
`ResponseInterface`	The same or new response