RouteGenerator
in package
Route Generator Class
The data model object representing a user's book cart.
Tags
Table of Contents
- $nonTabRecordActions : array<string|int, mixed>
- Record sub-routes are generally used to access tab plug-ins, but a few URLs are hard-coded to specific actions; this array lists those actions.
- $recordRoutes : array<string|int, mixed>
- Cache for already added recordActions which need to be used again if additional nonTabRecordActions will be added later.
- addDynamicRoute() : void
- Add a dynamic route to the configuration.
- addDynamicRoutes() : void
- Add dynamic routes to the configuration.
- addNonTabRecordAction() : void
- Add non tab record action & re-register all record routes to support it.
- addNonTabRecordActions() : void
- Add non tab record actions & re-register all record routes to support it.
- addRecordRoute() : void
- Add record route to the configuration.
- addRecordRoutes() : void
- Add record routes to the configuration.
- addStaticRoute() : void
- Add a simple static route to the configuration.
- addStaticRoutes() : void
- Add simple static routes to the configuration.
Properties
$nonTabRecordActions
Record sub-routes are generally used to access tab plug-ins, but a few URLs are hard-coded to specific actions; this array lists those actions.
protected
static array<string|int, mixed>
$nonTabRecordActions
= []
$recordRoutes
Cache for already added recordActions which need to be used again if additional nonTabRecordActions will be added later.
protected
static array<string|int, mixed>
$recordRoutes
= []
Methods
addDynamicRoute()
Add a dynamic route to the configuration.
public
addDynamicRoute(array<string|int, mixed> &$config, string $routeName, string $controller, string $action) : void
Parameters
- $config : array<string|int, mixed>
-
Configuration array to update
- $routeName : string
-
Name of route to generate
- $controller : string
-
Controller name
- $action : string
-
Action and any dynamic parts
Return values
void —addDynamicRoutes()
Add dynamic routes to the configuration.
public
addDynamicRoutes(array<string|int, mixed> &$config, array<string|int, mixed> $routes) : void
Parameters
- $config : array<string|int, mixed>
-
Configuration array to update
- $routes : array<string|int, mixed>
-
Associative array of arrays (controller => [route name => action]) of routes to add.
Return values
void —addNonTabRecordAction()
Add non tab record action & re-register all record routes to support it.
public
addNonTabRecordAction(array<string|int, mixed> &$config, string $action) : void
Parameters
- $config : array<string|int, mixed>
-
Configuration array to update
- $action : string
-
Action to add
Return values
void —addNonTabRecordActions()
Add non tab record actions & re-register all record routes to support it.
public
addNonTabRecordActions(array<string|int, mixed> &$config, array<string|int, mixed> $actions) : void
Parameters
- $config : array<string|int, mixed>
-
Configuration array to update
- $actions : array<string|int, mixed>
-
Action to add
Return values
void —addRecordRoute()
Add record route to the configuration.
public
addRecordRoute(array<string|int, mixed> &$config, string $routeBase, string $controller) : void
Parameters
- $config : array<string|int, mixed>
-
Configuration array to update
- $routeBase : string
-
Base name to use for routes
- $controller : string
-
Controller to point routes toward
Return values
void —addRecordRoutes()
Add record routes to the configuration.
public
addRecordRoutes(array<string|int, mixed> &$config, array<string|int, mixed> $routes) : void
Parameters
- $config : array<string|int, mixed>
-
Configuration array to update
- $routes : array<string|int, mixed>
-
Associative array (route base name => controller) of routes to add.
Return values
void —addStaticRoute()
Add a simple static route to the configuration.
public
addStaticRoute(array<string|int, mixed> &$config, string $route) : void
Parameters
- $config : array<string|int, mixed>
-
Configuration array to update
- $route : string
-
Controller/Action string representing route
Return values
void —addStaticRoutes()
Add simple static routes to the configuration.
public
addStaticRoutes(array<string|int, mixed> &$config, array<string|int, mixed> $routes) : void
Parameters
- $config : array<string|int, mixed>
-
Configuration array to update
- $routes : array<string|int, mixed>
-
Array of Controller/Action strings representing routes