1. class
  2. Lemonade
  3. \
  4. Framework
  5. \
  6. Routing
  7. \
  8. Router

Router

final class Router (View source)

Methods

__construct()
Route
get(string $path, string $handler)
Route
Route
post(string $path, string $handler)
Route
Route
put(string $path, string $handler)
Route
Route
patch(string $path, string $handler)
Route
Route
delete(string $path, string $handler)
Route
Route
head(string $path, string $handler)
Route
Route
options(string $path, string $handler)
Route
Route
getNamed(string $name, string $path, string $handler)
Route
Route
postNamed(string $name, string $path, string $handler)
Route
Route
putNamed(string $name, string $path, string $handler)
Route
Route
patchNamed(string $name, string $path, string $handler)
Route
Route
deleteNamed(string $name, string $path, string $handler)
Route
Route
headNamed(string $name, string $path, string $handler)
Route
Route
optionsNamed(string $name, string $path, string $handler)
Route
Route
map(HttpMethod|string $method, string $path, string $handler)
Route
Route
mapNamed(string $name, HttpMethod|string $method, string $path, string $handler)
Route
RouteGroup
group(string $prefix, callable $builder)
RouteGroup
LocalizedRouteGroup
localizedGroup(callable $builder)
LocalizedRouteGroup
void
configureLocalizedRoutes(string $routeNamePrefix = 'localized.', string|null $routePrefix = null, string $localeParameter = 'locale', array $supportedLocales = [])
void
string
url(string $name, array $params = [])
string
void
setControllerNamespace(string $namespace)
void
RouteMatch
match(ServerRequestInterface $request)
RouteMatch
array
allowedMethodsForPath(string $path)
array
bool
hasExplicitRouteForPath(HttpMethod|string $method, string $path)
bool

Details

__construct

__construct()
at line 44

No description

get

Route get(string $path, string $handler)
at line 49

No description

Parameters

string $path
string $handler

Return Value

Route

post

Route post(string $path, string $handler)
at line 54

No description

Parameters

string $path
string $handler

Return Value

Route

put

Route put(string $path, string $handler)
at line 59

No description

Parameters

string $path
string $handler

Return Value

Route

patch

Route patch(string $path, string $handler)
at line 64

No description

Parameters

string $path
string $handler

Return Value

Route

delete

Route delete(string $path, string $handler)
at line 69

No description

Parameters

string $path
string $handler

Return Value

Route

head

Route head(string $path, string $handler)
at line 74

No description

Parameters

string $path
string $handler

Return Value

Route

options

Route options(string $path, string $handler)
at line 79

No description

Parameters

string $path
string $handler

Return Value

Route

getNamed

Route getNamed(string $name, string $path, string $handler)
at line 84

No description

Parameters

string $name
string $path
string $handler

Return Value

Route

postNamed

Route postNamed(string $name, string $path, string $handler)
at line 89

No description

Parameters

string $name
string $path
string $handler

Return Value

Route

putNamed

Route putNamed(string $name, string $path, string $handler)
at line 94

No description

Parameters

string $name
string $path
string $handler

Return Value

Route

patchNamed

Route patchNamed(string $name, string $path, string $handler)
at line 99

No description

Parameters

string $name
string $path
string $handler

Return Value

Route

deleteNamed

Route deleteNamed(string $name, string $path, string $handler)
at line 104

No description

Parameters

string $name
string $path
string $handler

Return Value

Route

headNamed

Route headNamed(string $name, string $path, string $handler)
at line 109

No description

Parameters

string $name
string $path
string $handler

Return Value

Route

optionsNamed

Route optionsNamed(string $name, string $path, string $handler)
at line 114

No description

Parameters

string $name
string $path
string $handler

Return Value

Route

map

Route map(HttpMethod|string $method, string $path, string $handler)
at line 119

No description

Parameters

HttpMethod|string $method
string $path
string $handler

Return Value

Route

mapNamed

Route mapNamed(string $name, HttpMethod|string $method, string $path, string $handler)
at line 141

No description

Parameters

string $name
HttpMethod|string $method
string $path
string $handler

Return Value

Route

group

RouteGroup group(string $prefix, callable $builder)
at line 165

No description

Parameters

string $prefix
callable $builder

Return Value

RouteGroup

localizedGroup

LocalizedRouteGroup localizedGroup(callable $builder)
at line 185

No description

Parameters

callable $builder

Return Value

LocalizedRouteGroup

configureLocalizedRoutes

void configureLocalizedRoutes(string $routeNamePrefix = 'localized.', string|null $routePrefix = null, string $localeParameter = 'locale', array $supportedLocales = [])
at line 211

No description

Parameters

string $routeNamePrefix
string|null $routePrefix
string $localeParameter
array $supportedLocales

Return Value

void

url

string url(string $name, array $params = [])
at line 243

No description

Parameters

string $name
array $params

Return Value

string

setControllerNamespace

void setControllerNamespace(string $namespace)
at line 252

No description

Parameters

string $namespace

Return Value

void

match

RouteMatch match(ServerRequestInterface $request)
at line 257

No description

Parameters

ServerRequestInterface $request

Return Value

RouteMatch

allowedMethodsForPath

array allowedMethodsForPath(string $path)
at line 286

No description

Parameters

string $path

Return Value

array

hasExplicitRouteForPath

bool hasExplicitRouteForPath(HttpMethod|string $method, string $path)
at line 302

No description

Parameters

HttpMethod|string $method
string $path

Return Value

bool