W3cubDocs

/Laravel 5.4

Router

class Router implements Registrar, BindingRegistrar (View source)

Traits

Macroable

Properties

array $middlewarePriority The priority-sorted list of middleware.
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.

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

Register a new GET route with the router.

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

Register a new POST route with the router.

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

Register a new PUT route with the router.

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

Register a new PATCH route with the router.

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

Register a new DELETE route with the router.

void 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.

void 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 = array())

Route a resource to a controller.

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

Create a route group with shared attributes.

array mergeWithLastGroup(array $new)

Merge the given array with the last group stack.

string getLastGroupPrefix()

Get the prefix from the last group on the stack.

Response dispatch(Request $request)

Dispatch the request to the application.

mixed dispatchToRoute(Request $request)

Dispatch the request to a route and return the response.

array gatherRouteMiddleware(Route $route)

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

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.

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 = array())

Set the global resource parameter mapping.

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

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

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

Register a custom macro.

Parameters

string $name
callable $macro

Return Value

void

static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

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

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

Dynamically handle calls into the router instance.

Parameters

string $method
array $parameters

Return Value

mixed

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

Create a new Router instance.

Parameters

Dispatcher $events
Container $container

Return Value

void

void 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

void

void 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

void

void 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

void

void 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

void

void 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

void

void 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

void

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

void 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

void

void resources(array $resources)

Register an array of resource controllers.

Parameters

array $resources

Return Value

void

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

Route a resource to a controller.

Parameters

string $name
string $controller
array $options

Return Value

void

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

Create a route group with shared attributes.

Parameters

array $attributes
Closure|string $routes

Return Value

void

array mergeWithLastGroup(array $new)

Merge the given array with the last group stack.

Parameters

array $new

Return Value

array

string getLastGroupPrefix()

Get the prefix from the last group on the stack.

Return Value

string

Response dispatch(Request $request)

Dispatch the request to the application.

Parameters

Request $request

Return Value

Response

mixed dispatchToRoute(Request $request)

Dispatch the request to a route and return the response.

Parameters

Request $request

Return Value

mixed

array gatherRouteMiddleware(Route $route)

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

Parameters

Route $route

Return Value

array

Response prepareResponse(Request $request, mixed $response)

Create a response instance from the given value.

Parameters

Request $request
mixed $response

Return Value

Response

Route substituteBindings(Route $route)

Substitute the route bindings onto the route.

Parameters

Route $route

Return Value

Route

void substituteImplicitBindings(Route $route)

Substitute the implicit Eloquent model bindings for the route.

Parameters

Route $route

Return Value

void

void matched(string|callable $callback)

Register a route matched event listener.

Parameters

string|callable $callback

Return Value

void

array getMiddleware()

Get all of the defined middleware short-hand names.

Return Value

array

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

Register a short-hand name for a middleware.

Parameters

string $name
string $class

Return Value

$this

bool hasMiddlewareGroup(string $name)

Check if a middlewareGroup with the given name exists.

Parameters

string $name

Return Value

bool

array getMiddlewareGroups()

Get all of the defined middleware groups.

Return Value

array

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

Register a group of middleware.

Parameters

string $name
array $middleware

Return Value

$this

$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

$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

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

Add a new route parameter binder.

Parameters

string $key
string|callable $binder

Return Value

void

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

Closure getBindingCallback(string $key)

Get the binding callback for a given binding.

Parameters

string $key

Return Value

Closure

array getPatterns()

Get the global "where" patterns.

Return Value

array

void pattern(string $key, string $pattern)

Set a global where pattern on all routes.

Parameters

string $key
string $pattern

Return Value

void

void patterns(array $patterns)

Set a group of global where patterns on all routes.

Parameters

array $patterns

Return Value

void

bool hasGroupStack()

Determine if the router currently has a group stack.

Return Value

bool

array getGroupStack()

Get the current group stack for the router.

Return Value

array

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

Get a route parameter for the current route.

Parameters

string $key
string $default

Return Value

mixed

Request getCurrentRequest()

Get the request currently being dispatched.

Return Value

Request

Route getCurrentRoute()

Get the currently dispatched route instance.

Return Value

Route

Route current()

Get the currently dispatched route instance.

Return Value

Route

bool has(string $name)

Check if a route with the given name exists.

Parameters

string $name

Return Value

bool

string|null currentRouteName()

Get the current route name.

Return Value

string|null

bool is()

Alias for the "currentRouteNamed" method.

Return Value

bool

bool currentRouteNamed(string $name)

Determine if the current route matches a given name.

Parameters

string $name

Return Value

bool

string|null currentRouteAction()

Get the current route action.

Return Value

string|null

bool uses()

Alias for the "currentRouteUses" method.

Return Value

bool

bool currentRouteUses(string $action)

Determine if the current route action matches a given action.

Parameters

string $action

Return Value

bool

void auth()

Register the typical authentication routes for an application.

Return Value

void

void singularResourceParameters(bool $singular = true)

Set the unmapped global resource parameters to singular.

Parameters

bool $singular

Return Value

void

void resourceParameters(array $parameters = array())

Set the global resource parameter mapping.

Parameters

array $parameters

Return Value

void

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

Get or set the verbs used in the resource URIs.

Parameters

array $verbs

Return Value

array|null

RouteCollection getRoutes()

Get the underlying route collection.

Return Value

RouteCollection

void setRoutes(RouteCollection $routes)

Set the route collection instance.

Parameters

RouteCollection $routes

Return Value

void

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.4/Illuminate/Routing/Router.html