1. interface
  2. Concrete
  3. \
  4. Core
  5. \
  6. Routing
  7. \
  8. RouterInterface

RouterInterface

interface RouterInterface (View source)

Methods

RouteActionInterface
resolveAction(Route $route)

No description

RouteCollection[]
getRoutes()

No description

addRoute(Route $route)

No description

Route
getRouteByPath(string $path, RequestContext $context, array $routeAttributes = [])

Get a route given its path.

MatchedRoute
matchRoute(Request $request)

No description

loadRouteList(RouteListInterface $list)

No description

Details

at line 15
RouteActionInterface resolveAction(Route $route)

No description

Parameters

Route $route

Return Value

RouteActionInterface

at line 20
RouteCollection[] getRoutes()

No description

Return Value

RouteCollection[]

at line 25
addRoute(Route $route)

No description

Parameters

Route $route

at line 40
Route getRouteByPath(string $path, RequestContext $context, array $routeAttributes = [])

Get a route given its path.

Parameters

string $path

the path to be looked for
RequestContext $context

the context to be used to match the routes
array $routeAttributes

[output] if specified, this argument will contain the route attributes

Return Value

Route

Exceptions

NoConfigurationException

If no routing configuration could be found
ResourceNotFoundException

If the resource could not be found
MethodNotAllowedException

If the resource was found but the request method is not allowed

at line 51
MatchedRoute matchRoute(Request $request)

No description

Parameters

Request $request

Return Value

MatchedRoute

Exceptions

NoConfigurationException

If no routing configuration could be found
ResourceNotFoundException

If the resource could not be found
MethodNotAllowedException

If the resource was found but the request method is not allowed

at line 53
loadRouteList(RouteListInterface $list)

No description

Parameters

RouteListInterface $list