ServerRouter
extends Router
in package
implements
RouterInterface
Server router
Table of Contents
Interfaces
- RouterInterface
- Router interface
Properties
- $container : ContainerInterface
- App container
- $generator : RouteGenerator
- Route generator
- $routeLoader : null|object
- Route loader
- $routeMiddlewares : array<string|int, mixed>
- Route middlewares
- $routeOptions : array<string|int, mixed>
- Route options
Methods
- __construct() : mixed
- Constructor
- addRoute() : void
- Add route
- addRouteMiddleware() : void
- Add route middleware
- dispatch() : array<string|int, mixed>
- Dispatch route
- getGenerator() : RouteGenerator
- Get route generator
- getMiddlewares() : array<string|int, mixed>
- Get middlewares per method
- getRouteMiddlewares() : array<string|int, mixed>
- Get route middlewares
- getRouteOptions() : array<string|int, mixed>
- Get reoute options
- loadRoutes() : void
- Load routes
- mapRoutes() : bool
- Map extensons and templates routes
- dispatchVariableRoute() : array<string|int, mixed>|null
- Dispatch variable route
- mapSystemRoutes() : void
- Map system routes
Properties
$container
App container
protected
ContainerInterface
$container
$generator
Route generator
protected
RouteGenerator
$generator
$routeLoader
Route loader
protected
null|object
$routeLoader
$routeMiddlewares
Route middlewares
protected
array<string|int, mixed>
$routeMiddlewares
= []
$routeOptions
Route options
protected
array<string|int, mixed>
$routeOptions
= []
Methods
__construct()
Constructor
public
__construct(ContainerInterface $container, string $basePath[, object|null $routeLoader = null ]) : mixed
Parameters
- $container : ContainerInterface
- $basePath : string
- $routeLoader : object|null = null
addRoute()
Add route
public
addRoute(string $method, string $pattern, string $handlerClass[, array<string|int, mixed> $options = [] ][, string|int|null $routeId = null ]) : void
Parameters
- $method : string
- $pattern : string
- $handlerClass : string
- $options : array<string|int, mixed> = []
- $routeId : string|int|null = null
addRouteMiddleware()
Add route middleware
public
addRouteMiddleware(string $method, string $handlerClass, string $middleware) : void
Parameters
- $method : string
- $handlerClass : string
- $middleware : string
dispatch()
Dispatch route
public
dispatch(string $method, string $uri, array<string|int, mixed> $staticRoutes, array<string|int, mixed> $variableRoutes) : array<string|int, mixed>
Parameters
- $method : string
- $uri : string
- $staticRoutes : array<string|int, mixed>
- $variableRoutes : array<string|int, mixed>
Return values
array<string|int, mixed>getGenerator()
Get route generator
public
getGenerator() : RouteGenerator
Return values
RouteGeneratorgetMiddlewares()
Get middlewares per method
public
getMiddlewares(string $method) : array<string|int, mixed>
Parameters
- $method : string
Return values
array<string|int, mixed>getRouteMiddlewares()
Get route middlewares
public
getRouteMiddlewares(string $method, string $handlerClass) : array<string|int, mixed>
Parameters
- $method : string
- $handlerClass : string
Return values
array<string|int, mixed>getRouteOptions()
Get reoute options
public
getRouteOptions(string $method, string|int $id) : array<string|int, mixed>
Parameters
- $method : string
- $id : string|int
Return values
array<string|int, mixed>loadRoutes()
Load routes
public
loadRoutes(mixed ...$options) : void
Parameters
- $options : mixed
mapRoutes()
Map extensons and templates routes
public
mapRoutes([int|null $type = null ]) : bool
Parameters
- $type : int|null = null
Tags
Return values
booldispatchVariableRoute()
Dispatch variable route
protected
dispatchVariableRoute(array<string|int, mixed> $routes, string $uri) : array<string|int, mixed>|null
Parameters
- $routes : array<string|int, mixed>
- $uri : string
Return values
array<string|int, mixed>|nullmapSystemRoutes()
Map system routes
protected
mapSystemRoutes() : void