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

RouterInterface

interface RouterInterface (View source)

Methods

RequestContext
getContext()

Get the context that the router is running in.

setContext(RequestContext $context)

No description

UrlGeneratorInterface
getGenerator()

No description

setGenerator(UrlGeneratorInterface $generator)

No description

getList()

No description

setRequest(Request $req)

No description

Route
register(string $path, Closure|string $callback, string|null $handle = null, array $requirements = array(), array $options = array(), string $host = '', array|string $schemes = array(), array|string $methods = array(), string $condition = null)

Register a symfony route with as little as a path and a callback.

registerMultiple(array $routes)

No description

execute(Route $route, $parameters)

No description

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

Used by the theme_paths and site_theme_paths files in config/ to hard coded certain paths to various themes.

setThemesbyRoutes(array $routes)

No description

string|bool
getThemeByRoute(string $path)

This grabs the theme for a particular path, if one exists in the themePaths array.

route($data)

No description

Details

at line 15
RequestContext getContext()

Get the context that the router is running in.

Return Value

RequestContext

at line 20
setContext(RequestContext $context)

No description

Parameters

RequestContext $context

at line 25
UrlGeneratorInterface getGenerator()

No description

Return Value

UrlGeneratorInterface

at line 30
setGenerator(UrlGeneratorInterface $generator)

No description

Parameters

UrlGeneratorInterface $generator

at line 32
getList()

No description

at line 34
setRequest(Request $req)

No description

Parameters

Request $req

at line 51
Route register(string $path, Closure|string $callback, string|null $handle = null, array $requirements = array(), array $options = array(), string $host = '', array|string $schemes = array(), array|string $methods = array(), string $condition = null)

Register a symfony route with as little as a path and a callback.

Parameters

string $path

The full path for the route
Closure|string $callback

\Closure or "dispatcher" or "\Namespace\Controller::action_method"
string|null $handle

The route handle, if one is not provided the handle is generated from the path "/" => "_"
array $requirements

The Parameter requirements, see Symfony Route constructor
array $options

The route options, see Symfony Route constructor
string $host

The host pattern this route requires, see Symfony Route constructor
array|string $schemes

The schemes or scheme this route requires, see Symfony Route constructor
array|string $methods

The HTTP methods this route requires, see see Symfony Route constructor
string $condition

see Symfony Route constructor

Return Value

Route

at line 62
registerMultiple(array $routes)

No description

Parameters

array $routes

at line 64
execute(Route $route, $parameters)

No description

Parameters

Route $route
$parameters

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

Used by the theme_paths and site_theme_paths files in config/ to hard coded certain paths to various themes.

Parameters

$path string
$theme

object, if null site theme is default
$wrapper

at line 74
setThemesbyRoutes(array $routes)

No description

Parameters

array $routes

at line 83
string|bool getThemeByRoute(string $path)

This grabs the theme for a particular path, if one exists in the themePaths array.

Parameters

string $path

Return Value

string|bool

at line 85
route($data)

No description

Parameters

$data