1. class
  2. Concrete
  3. \
  4. Core
  5. \
  6. Routing
  7. \
  8. Router

Router

class Router implements RouterInterface (View source)

Properties

protected RouteActionFactoryInterface $actionFactory
protected RouteCollection $routes

Methods

__construct(RouteCollection $routes, RouteActionFactoryInterface $actionFactory)

No description

buildGroup()

No description

RouteBuilder
get(string $path, string $action)

No description

RouteBuilder
head(string $path, string $action)

No description

RouteBuilder
post(string $path, string $action)

No description

RouteBuilder
put(string $path, string $action)

No description

RouteBuilder
patch(string $path, string $action)

No description

RouteBuilder
delete(string $path, string $action)

No description

RouteBuilder
options(string $path, string $action)

No description

RouteBuilder
all(string $path, string $action)

No description

RouteActionInterface
resolveAction(Route $route)

No description

RouteCollection[]
getRoutes()

No description

RouteActionFactoryInterface
getActionFactory()

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

register($path, $callback, $handle = null, array $requirements = [], array $options = [], $host = '', $schemes = [], $methods = [], $condition = null)

No description

registerMultiple(array $routes)

No description

string
route($data) deprecated

Returns a route string based on data. DO NOT USE THIS.

setThemeByRoute($path, $theme = null, $wrapper = FILENAME_THEMES_VIEW) deprecated

No description

normalizePath($path)

No description

createRouteBuilder($path, $action, $methods)

No description

RouteCollection
filterRouteCollectionForPath(RouteCollection $routes, string $path)

No description

Details

at line 24
__construct(RouteCollection $routes, RouteActionFactoryInterface $actionFactory)

No description

Parameters

RouteCollection $routes
RouteActionFactoryInterface $actionFactory

at line 32
buildGroup()

No description

at line 45
RouteBuilder get(string $path, string $action)

Since: 8.5.0a2

No description

Parameters

string $path
string $action

Return Value

RouteBuilder

at line 58
RouteBuilder head(string $path, string $action)

Since: 8.5.0a2

No description

Parameters

string $path
string $action

Return Value

RouteBuilder

at line 71
RouteBuilder post(string $path, string $action)

Since: 8.5.0a2

No description

Parameters

string $path
string $action

Return Value

RouteBuilder

at line 84
RouteBuilder put(string $path, string $action)

Since: 8.5.0a2

No description

Parameters

string $path
string $action

Return Value

RouteBuilder

at line 97
RouteBuilder patch(string $path, string $action)

Since: 8.5.0a2

No description

Parameters

string $path
string $action

Return Value

RouteBuilder

at line 110
RouteBuilder delete(string $path, string $action)

Since: 8.5.0a2

No description

Parameters

string $path
string $action

Return Value

RouteBuilder

at line 123
RouteBuilder options(string $path, string $action)

Since: 8.5.0a2

No description

Parameters

string $path
string $action

Return Value

RouteBuilder

at line 136
RouteBuilder all(string $path, string $action)

Since: 8.5.0a2

No description

Parameters

string $path
string $action

Return Value

RouteBuilder

at line 148
RouteActionInterface resolveAction(Route $route)

No description

Parameters

Route $route

Return Value

RouteActionInterface

at line 156
RouteCollection[] getRoutes()

No description

Return Value

RouteCollection[]

at line 164
RouteActionFactoryInterface getActionFactory()

No description

Return Value

RouteActionFactoryInterface

at line 169
addRoute(Route $route)

No description

Parameters

Route $route

at line 179
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
ResourceNotFoundException
MethodNotAllowedException

See also

RouterInterface::getRouteByPath

at line 194
MatchedRoute matchRoute(Request $request)

No description

Parameters

Request $request

Return Value

MatchedRoute

Exceptions

NoConfigurationException
ResourceNotFoundException
MethodNotAllowedException

See also

RouterInterface::matchRoute

at line 204
loadRouteList(RouteListInterface $list)

No description

Parameters

RouteListInterface $list

at line 224
register($path, $callback, $handle = null, array $requirements = [], array $options = [], $host = '', $schemes = [], $methods = [], $condition = null)

No description

Parameters

$path
$callback
$handle
array $requirements
array $options
$host
$schemes
$methods
$condition

at line 254
registerMultiple(array $routes)

No description

Parameters

array $routes

at line 271
string route($data) deprecated

deprecated

Returns a route string based on data. DO NOT USE THIS.

Parameters

$data

Return Value

string

at line 308
setThemeByRoute($path, $theme = null, $wrapper = FILENAME_THEMES_VIEW) deprecated

deprecated Use $app->make(\Concrete\Core\Page\Theme\ThemeRouteCollection::class)->setThemeByRoute() with the same arguments {@inheritdoc}

No description

Parameters

$path
$theme
$wrapper

See also

ThemeRouteCollection::setThemeByRoute

at line 314
private normalizePath($path)

No description

Parameters

$path

at line 319
private createRouteBuilder($path, $action, $methods)

No description

Parameters

$path
$action
$methods

at line 334
private RouteCollection filterRouteCollectionForPath(RouteCollection $routes, string $path)

No description

Parameters

RouteCollection $routes
string $path

Return Value

RouteCollection