RouteRegistration
in package
implements
Bootstrapper
Class RouteRegistration
Interfaces, Classes and Traits
- Bootstrapper
- Interface Bootstrapper
Table of Contents
- CACHE_KEY = 'admin_routes'
- CACHE_NAMESPACE = 'application_routes'
- boot() : void
- Application bootstrapping.
- getCacheFactory() : CacheFactory
- getEnvironment() : Environment
- getRouteCollector() : RouteCollector
- getRoutes() : array<string|int, mixed>
- Returns all the GambioAdmin application routes.
- registerGambioAdminMenuRoutes() : void
- Registers routes for the gambio admin menu system.
- registerRoutes() : void
- Takes a list of absolute paths of route files and register them to the application using the RouteCollector.
Constants
CACHE_KEY
private
mixed
CACHE_KEY
= 'admin_routes'
CACHE_NAMESPACE
private
mixed
CACHE_NAMESPACE
= 'application_routes'
Methods
boot()
Application bootstrapping.
public
boot(Application $application) : void
Parameters
- $application : Application
Tags
Return values
void —getCacheFactory()
private
getCacheFactory(Application $application) : CacheFactory
Parameters
- $application : Application
Return values
CacheFactory —getEnvironment()
private
getEnvironment(Application $application) : Environment
Parameters
- $application : Application
Return values
Environment —getRouteCollector()
private
getRouteCollector(Application $application) : RouteCollector
Parameters
- $application : Application
Return values
RouteCollector —getRoutes()
Returns all the GambioAdmin application routes.
private
getRoutes() : array<string|int, mixed>
There are routes for modules and submodules. Routes for modules are loaded by looking into the module directory for a file called "routes.php". Similar, the method checks if the module directory contains a submodule directory with other route files and returns them too.
Return values
array<string|int, mixed> —registerGambioAdminMenuRoutes()
Registers routes for the gambio admin menu system.
private
registerGambioAdminMenuRoutes(RouteCollector $routeCollector) : void
Parameters
- $routeCollector : RouteCollector
Return values
void —registerRoutes()
Takes a list of absolute paths of route files and register them to the application using the RouteCollector.
private
registerRoutes(array<string|int, mixed> $routes, RouteCollector $routeCollector) : void
Parameters
- $routes : array<string|int, mixed>
- $routeCollector : RouteCollector