1. class
  2. Illuminate
  3. \
  4. Routing
  5. \
  6. Router

Router

class Router implements Registrar, BindingRegistrar

Traits

Macroable

Properties

static protected array $macros

The registered string macros.

 from  Macroable
protected Dispatcher $events

The event dispatcher instance.
protected Container $container

The IoC container instance.
protected RouteCollection $routes

The route collection instance.
protected Route $current

The currently dispatched route instance.
protected Request $currentRequest

The request currently being dispatched.
protected array $middleware

All of the short-hand keys for middlewares.
protected array $middlewareGroups

All of the middleware groups.
array $middlewarePriority

The priority-sorted list of middleware.
protected array $binders

The registered route value binders.
protected array $patterns

The globally available parameter patterns.
protected array $groupStack

The route group attribute stack.
static array $verbs

All of the verbs supported by the router.

Methods

static void
macro(string $name, callable $macro)

Register a custom macro.

from  Macroable
static bool
hasMacro(string $name)

Checks if macro is registered.

from  Macroable
static mixed
__callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
mixed
__call(string $method, array $parameters)

Dynamically handle calls into the router instance.

void
__construct(Dispatcher $events, Container $container = null)

Create a new Router instance.

Route
get(string $uri, Closure|array|string $action = null)

Register a new GET route with the router.

Route
post(string $uri, Closure|array|string $action = null)

Register a new POST route with the router.

Route
put(string $uri, Closure|array|string $action = null)

Register a new PUT route with the router.

Route
patch(string $uri, Closure|array|string $action = null)

Register a new PATCH route with the router.

Route
delete(string $uri, Closure|array|string $action = null)

Register a new DELETE route with the router.

Route
options(string $uri, Closure|array|string $action = null)

Register a new OPTIONS route with the router.

Route
any(string $uri, Closure|array|string|null $action = null)

Register a new route responding to all verbs.

Route
match(array|string $methods, string $uri, Closure|array|string $action = null)

Register a new route with the given verbs.

void
resources(array $resources)

Register an array of resource controllers.

void
resource(string $name, string $controller, array $options = [])

Route a resource to a controller.

void
apiResource(string $name, string $controller, array $options = [])

Route an api resource to a controller.

void
group(array $attributes, Closure|string $routes)

Create a route group with shared attributes.

void
updateGroupStack(array $attributes)

Update the group stack with the given attributes.

array
mergeWithLastGroup(array $new)

Merge the given array with the last group stack.

void
loadRoutes(Closure|string $routes)

Load the provided routes.

string
getLastGroupPrefix()

Get the prefix from the last group on the stack.

Route
addRoute(array|string $methods, string $uri, Closure|array|string|null $action)

Add a route to the underlying route collection.

Route
createRoute(array|string $methods, string $uri, mixed $action)

Create a new route instance.

bool
actionReferencesController(array $action)

Determine if the action is routing to a controller.

array
convertToControllerAction(array|string $action)

Add a controller based route action to the action array.

string
prependGroupNamespace(string $class)

Prepend the last group namespace onto the use clause.

Route
newRoute(array|string $methods, string $uri, mixed $action)

Create a new Route object.

string
prefix(string $uri)

Prefix the given URI with the last prefix.

Route
addWhereClausesToRoute(Route $route)

Add the necessary where clauses to the route based on its initial registration.

void
mergeGroupAttributesIntoRoute(Route $route)

Merge the group stack with the controller action.

Response
dispatch(Request $request)

Dispatch the request to the application.

mixed
dispatchToRoute(Request $request)

Dispatch the request to a route and return the response.

Route
findRoute(Request $request)

Find the route matching a given request.

mixed
runRouteWithinStack(Route $route, Request $request)

Run the given route within a Stack "onion" instance.

array
gatherRouteMiddleware(Route $route)

Gather the middleware for the given route with resolved class names.

array
sortMiddleware(Collection $middlewares)

Sort the given middleware by priority.

Response
prepareResponse(Request $request, mixed $response)

Create a response instance from the given value.

Route
substituteBindings(Route $route)

Substitute the route bindings onto the route.

void
substituteImplicitBindings(Route $route)

Substitute the implicit Eloquent model bindings for the route.

mixed
performBinding(string $key, string $value, Route $route)

Call the binding callback for the given key.

void
matched(string|callable $callback)

Register a route matched event listener.

array
getMiddleware()

Get all of the defined middleware short-hand names.

$this
aliasMiddleware(string $name, string $class)

Register a short-hand name for a middleware.

bool
hasMiddlewareGroup(string $name)

Check if a middlewareGroup with the given name exists.

array
getMiddlewareGroups()

Get all of the defined middleware groups.

$this
middlewareGroup(string $name, array $middleware)

Register a group of middleware.

$this
prependMiddlewareToGroup(string $group, string $middleware)

Add a middleware to the beginning of a middleware group.

$this
pushMiddlewareToGroup(string $group, string $middleware)

Add a middleware to the end of a middleware group.

void
bind(string $key, string|callable $binder)

Add a new route parameter binder.

void
model(string $key, string $class, Closure $callback = null)

Register a model binder for a wildcard.

Closure
getBindingCallback(string $key)

Get the binding callback for a given binding.

array
getPatterns()

Get the global "where" patterns.

void
pattern(string $key, string $pattern)

Set a global where pattern on all routes.

void
patterns(array $patterns)

Set a group of global where patterns on all routes.

bool
hasGroupStack()

Determine if the router currently has a group stack.

array
getGroupStack()

Get the current group stack for the router.

mixed
input(string $key, string $default = null)

Get a route parameter for the current route.

Request
getCurrentRequest()

Get the request currently being dispatched.

Route
getCurrentRoute()

Get the currently dispatched route instance.

Route
current()

Get the currently dispatched route instance.

bool
has(string $name)

Check if a route with the given name exists.

string|null
currentRouteName()

Get the current route name.

bool
is()

Alias for the "currentRouteNamed" method.

bool
currentRouteNamed(string $name)

Determine if the current route matches a given name.

string|null
currentRouteAction()

Get the current route action.

bool
uses()

Alias for the "currentRouteUses" method.

bool
currentRouteUses(string $action)

Determine if the current route action matches a given action.

void
auth()

Register the typical authentication routes for an application.

void
singularResourceParameters(bool $singular = true)

Set the unmapped global resource parameters to singular.

void
resourceParameters(array $parameters = [])

Set the global resource parameter mapping.

array|null
resourceVerbs(array $verbs = [])

Get or set the verbs used in the resource URIs.

RouteCollection
getRoutes()

Get the underlying route collection.

void
setRoutes(RouteCollection $routes)

Set the route collection instance.

Details

in Macroable at line 24
static void macro(string $name, callable $macro)

Register a custom macro.

Parameters

string $name
callable $macro

Return Value

void

in Macroable at line 35
static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 49
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line 1092
mixed __call(string $method, array $parameters)

Dynamically handle calls into the router instance.

Parameters

string $method
array $parameters

Return Value

mixed

at line 118
void __construct(Dispatcher $events, Container $container = null)

Create a new Router instance.

Parameters

Dispatcher $events
Container $container

Return Value

void

at line 132
Route get(string $uri, Closure|array|string $action = null)

Register a new GET route with the router.

Parameters

string $uri
Closure|array|string $action

Return Value

Route

at line 144
Route post(string $uri, Closure|array|string $action = null)

Register a new POST route with the router.

Parameters

string $uri
Closure|array|string $action

Return Value

Route

at line 156
Route put(string $uri, Closure|array|string $action = null)

Register a new PUT route with the router.

Parameters

string $uri
Closure|array|string $action

Return Value

Route

at line 168
Route patch(string $uri, Closure|array|string $action = null)

Register a new PATCH route with the router.

Parameters

string $uri
Closure|array|string $action

Return Value

Route

at line 180
Route delete(string $uri, Closure|array|string $action = null)

Register a new DELETE route with the router.

Parameters

string $uri
Closure|array|string $action

Return Value

Route

at line 192
Route options(string $uri, Closure|array|string $action = null)

Register a new OPTIONS route with the router.

Parameters

string $uri
Closure|array|string $action

Return Value

Route

at line 204
Route any(string $uri, Closure|array|string|null $action = null)

Register a new route responding to all verbs.

Parameters

string $uri
Closure|array|string|null $action

Return Value

Route

at line 217
Route match(array|string $methods, string $uri, Closure|array|string $action = null)

Register a new route with the given verbs.

Parameters

array|string $methods
string $uri
Closure|array|string $action

Return Value

Route

at line 228
void resources(array $resources)

Register an array of resource controllers.

Parameters

array $resources

Return Value

void

at line 243
void resource(string $name, string $controller, array $options = [])

Route a resource to a controller.

Parameters

string $name
string $controller
array $options

Return Value

void

at line 262
void apiResource(string $name, string $controller, array $options = [])

Route an api resource to a controller.

Parameters

string $name
string $controller
array $options

Return Value

void

at line 276
void group(array $attributes, Closure|string $routes)

Create a route group with shared attributes.

Parameters

array $attributes
Closure|string $routes

Return Value

void

at line 294
protected void updateGroupStack(array $attributes)

Update the group stack with the given attributes.

Parameters

array $attributes

Return Value

void

at line 309
array mergeWithLastGroup(array $new)

Merge the given array with the last group stack.

Parameters

array $new

Return Value

array

at line 320
protected void loadRoutes(Closure|string $routes)

Load the provided routes.

Parameters

Closure|string $routes

Return Value

void

at line 336
string getLastGroupPrefix()

Get the prefix from the last group on the stack.

Return Value

string

at line 355
protected Route addRoute(array|string $methods, string $uri, Closure|array|string|null $action)

Add a route to the underlying route collection.

Parameters

array|string $methods
string $uri
Closure|array|string|null $action

Return Value

Route

at line 368
protected Route createRoute(array|string $methods, string $uri, mixed $action)

Create a new route instance.

Parameters

array|string $methods
string $uri
mixed $action

Return Value

Route

at line 399
protected bool actionReferencesController(array $action)

Determine if the action is routing to a controller.

Parameters

array $action

Return Value

bool

at line 414
protected array convertToControllerAction(array|string $action)

Add a controller based route action to the action array.

Parameters

array|string $action

Return Value

array

at line 441
protected string prependGroupNamespace(string $class)

Prepend the last group namespace onto the use clause.

Parameters

string $class

Return Value

string

at line 457
protected Route newRoute(array|string $methods, string $uri, mixed $action)

Create a new Route object.

Parameters

array|string $methods
string $uri
mixed $action

Return Value

Route

at line 470
protected string prefix(string $uri)

Prefix the given URI with the last prefix.

Parameters

string $uri

Return Value

string

at line 481
protected Route addWhereClausesToRoute(Route $route)

Add the necessary where clauses to the route based on its initial registration.

Parameters

Route $route

Return Value

Route

at line 496
protected void mergeGroupAttributesIntoRoute(Route $route)

Merge the group stack with the controller action.

Parameters

Route $route

Return Value

void

at line 507
Response dispatch(Request $request)

Dispatch the request to the application.

Parameters

Request $request

Return Value

Response

at line 520
mixed dispatchToRoute(Request $request)

Dispatch the request to a route and return the response.

Parameters

Request $request

Return Value

mixed

at line 544
protected Route findRoute(Request $request)

Find the route matching a given request.

Parameters

Request $request

Return Value

Route

at line 560
protected mixed runRouteWithinStack(Route $route, Request $request)

Run the given route within a Stack "onion" instance.

Parameters

Route $route
Request $request

Return Value

mixed

at line 583
array gatherRouteMiddleware(Route $route)

Gather the middleware for the given route with resolved class names.

Parameters

Route $route

Return Value

array

at line 598
protected array sortMiddleware(Collection $middlewares)

Sort the given middleware by priority.

Parameters

Collection $middlewares

Return Value

array

at line 610
Response prepareResponse(Request $request, mixed $response)

Create a response instance from the given value.

Parameters

Request $request
mixed $response

Return Value

Response

at line 627
Route substituteBindings(Route $route)

Substitute the route bindings onto the route.

Parameters

Route $route

Return Value

Route

at line 644
void substituteImplicitBindings(Route $route)

Substitute the implicit Eloquent model bindings for the route.

Parameters

Route $route

Return Value

void

at line 657
protected mixed performBinding(string $key, string $value, Route $route)

Call the binding callback for the given key.

Parameters

string $key
string $value
Route $route

Return Value

mixed

at line 668
void matched(string|callable $callback)

Register a route matched event listener.

Parameters

string|callable $callback

Return Value

void

at line 678
array getMiddleware()

Get all of the defined middleware short-hand names.

Return Value

array

at line 690
$this aliasMiddleware(string $name, string $class)

Register a short-hand name for a middleware.

Parameters

string $name
string $class

Return Value

$this

at line 703
bool hasMiddlewareGroup(string $name)

Check if a middlewareGroup with the given name exists.

Parameters

string $name

Return Value

bool

at line 713
array getMiddlewareGroups()

Get all of the defined middleware groups.

Return Value

array

at line 725
$this middlewareGroup(string $name, array $middleware)

Register a group of middleware.

Parameters

string $name
array $middleware

Return Value

$this

at line 741
$this prependMiddlewareToGroup(string $group, string $middleware)

Add a middleware to the beginning of a middleware group.

If the middleware is already in the group, it will not be added again.

Parameters

string $group
string $middleware

Return Value

$this

at line 759
$this pushMiddlewareToGroup(string $group, string $middleware)

Add a middleware to the end of a middleware group.

If the middleware is already in the group, it will not be added again.

Parameters

string $group
string $middleware

Return Value

$this

at line 779
void bind(string $key, string|callable $binder)

Add a new route parameter binder.

Parameters

string $key
string|callable $binder

Return Value

void

at line 796
void model(string $key, string $class, Closure $callback = null)

Register a model binder for a wildcard.

Parameters

string $key
string $class
Closure $callback

Return Value

void

Exceptions

ModelNotFoundException

at line 807
Closure getBindingCallback(string $key)

Get the binding callback for a given binding.

Parameters

string $key

Return Value

Closure

at line 819
array getPatterns()

Get the global "where" patterns.

Return Value

array

at line 831
void pattern(string $key, string $pattern)

Set a global where pattern on all routes.

Parameters

string $key
string $pattern

Return Value

void

at line 842
void patterns(array $patterns)

Set a group of global where patterns on all routes.

Parameters

array $patterns

Return Value

void

at line 854
bool hasGroupStack()

Determine if the router currently has a group stack.

Return Value

bool

at line 864
array getGroupStack()

Get the current group stack for the router.

Return Value

array

at line 876
mixed input(string $key, string $default = null)

Get a route parameter for the current route.

Parameters

string $key
string $default

Return Value

mixed

at line 886
Request getCurrentRequest()

Get the request currently being dispatched.

Return Value

Request

at line 896
Route getCurrentRoute()

Get the currently dispatched route instance.

Return Value

Route

at line 906
Route current()

Get the currently dispatched route instance.

Return Value

Route

at line 917
bool has(string $name)

Check if a route with the given name exists.

Parameters

string $name

Return Value

bool

at line 927
string|null currentRouteName()

Get the current route name.

Return Value

string|null

at line 937
bool is()

Alias for the "currentRouteNamed" method.

Return Value

bool

at line 954
bool currentRouteNamed(string $name)

Determine if the current route matches a given name.

Parameters

string $name

Return Value

bool

at line 964
string|null currentRouteAction()

Get the current route action.

Return Value

string|null

at line 980
bool uses()

Alias for the "currentRouteUses" method.

Return Value

bool

at line 997
bool currentRouteUses(string $action)

Determine if the current route action matches a given action.

Parameters

string $action

Return Value

bool

at line 1007
void auth()

Register the typical authentication routes for an application.

Return Value

void

at line 1031
void singularResourceParameters(bool $singular = true)

Set the unmapped global resource parameters to singular.

Parameters

bool $singular

Return Value

void

at line 1042
void resourceParameters(array $parameters = [])

Set the global resource parameter mapping.

Parameters

array $parameters

Return Value

void

at line 1053
array|null resourceVerbs(array $verbs = [])

Get or set the verbs used in the resource URIs.

Parameters

array $verbs

Return Value

array|null

at line 1063
RouteCollection getRoutes()

Get the underlying route collection.

Return Value

RouteCollection

at line 1074
void setRoutes(RouteCollection $routes)

Set the route collection instance.

Parameters

RouteCollection $routes

Return Value

void