RouterInterface
in
Router interface
Table of Contents
Constants
- METHOD_NOT_ALLOWED = 2
- ROUTE_FOUND = 1
- ROUTE_NOT_FOUND = 0
Methods
- addRoute() : void
- Add route
- addRouteMiddleware() : void
- Add route middleware
- dispatch() : array<string|int, mixed>
- Dispatch route
- getRouteMiddlewares() : array<string|int, mixed>
- Get route middlewares
- getRouteOptions() : array<string|int, mixed>
- Get reoute options
- loadRoutes() : int
- Load routes
Constants
METHOD_NOT_ALLOWED
public
mixed
METHOD_NOT_ALLOWED
= 2
ROUTE_FOUND
public
mixed
ROUTE_FOUND
= 1
ROUTE_NOT_FOUND
public
mixed
ROUTE_NOT_FOUND
= 0
Methods
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>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) : int
Parameters
- $options : mixed
Return values
int —(route type)