ErrorController
extends ControllerBase
in package
Error controller
Table of Contents
- error401Action() : mixed
- error500Action() : mixed
- indexAction() : mixed
- Handle the display of error messages
- initialize() : mixed
- Initialize response headers
- licenseAction() : mixed
- Handle the display of license error messages
- enableCompatibilityView() : bool
- Enables path to Gryphon compatible view, if the view exists AND enableCompatibility is on.
- getHttpCodeDescription() : mixed
- getJsonData() : array<string|int, mixed>
- Fetch POSTed/PUTed json data
- getRequestSegments() : mixed
- Return rewrite url segments
- terminateWithView() : mixed
- Terminate the action with a view partial. Will dump output directly to browser, but return the action allowing process to continue.
Methods
error401Action()
public
error401Action() : mixed
Return values
mixed —error500Action()
public
error500Action() : mixed
Return values
mixed —indexAction()
Handle the display of error messages
public
indexAction(mixed $message[, mixed $code = 404 ]) : mixed
Returns the following to the view:
- message - the error message string
- code - the error code (HTTP status code)
Looks for templates in the following order:
- error/XXX.twig - code specific
- error/index.twig
Then fails over to global templates:
- global-errors/XXX.twig - code specific
- global-errors/500.twig
Parameters
- $message : mixed
- $code : mixed = 404
Return values
mixed —initialize()
Initialize response headers
public
initialize() : mixed
Return values
mixed —licenseAction()
Handle the display of license error messages
public
licenseAction(mixed $message[, mixed $code = 500 ]) : mixed
Returns the following to the view:
- message - the error message string
Looks for templates in the following order:
- error/index.twig
Parameters
- $message : mixed
- $code : mixed = 500
Return values
mixed —enableCompatibilityView()
Enables path to Gryphon compatible view, if the view exists AND enableCompatibility is on.
protected
enableCompatibilityView(string $view) : bool
NOTE: This will mutate the internal view.
Parameters
- $view : string
Return values
bool —getHttpCodeDescription()
protected
getHttpCodeDescription(mixed $code) : mixed
Parameters
- $code : mixed
Return values
mixed —getJsonData()
Fetch POSTed/PUTed json data
protected
getJsonData() : array<string|int, mixed>
Return values
array<string|int, mixed> —getRequestSegments()
Return rewrite url segments
protected
getRequestSegments([mixed $i = null ]) : mixed
Parameters
- $i : mixed = null
Return values
mixed —either all segments as array, or single segment
terminateWithView()
Terminate the action with a view partial. Will dump output directly to browser, but return the action allowing process to continue.
protected
terminateWithView(string $view[, array<string|int, mixed> $params = [] ][, array<string|int, mixed> $headers = [] ]) : mixed
Parameters
- $view : string
-
path
- $params : array<string|int, mixed> = []
-
view params
- $headers : array<string|int, mixed> = []
-
optional headers