DefaultrouteController
extends ControllerBase
in package
DefaultRouteController handles custom routing
Table of Contents
- anyAction() : mixed
- Any exists as a null endpont for any route to attach to.
- indexAction() : Dispatcher
- By checking the custom route table, dispatch controller actions based on custom routing rules.
- initialize() : mixed
- Initialize response headers
- 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
anyAction()
Any exists as a null endpont for any route to attach to.
public
anyAction() : mixed
The use case being, you create a route which has an endpoint of
defaultRoute::any
Then you use an interceptor to handle the template data load.
Return values
mixed —indexAction()
By checking the custom route table, dispatch controller actions based on custom routing rules.
public
indexAction() : Dispatcher
Return values
Dispatcher —initialize()
Initialize response headers
public
initialize() : mixed
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