W3cubDocs

/Laravel 8

RouteCollectionInterface

interface RouteCollectionInterface (View source)

Methods

Route

add(Route $route)

Add a Route instance to the collection.

void

refreshNameLookups()

Refresh the name look-up table.

void

refreshActionLookups()

Refresh the action look-up table.

Route

match(Request $request)

Find the first route matching a given request.

Route[]

get(string|null $method = null)

Get routes from the collection by method.

bool

hasNamedRoute(string $name)

Determine if the route collection contains a given named route.

Route|null

getByName(string $name)

Get a route instance by its name.

Route|null

getByAction(string $action)

Get a route instance by its controller action.

Route[]

getRoutes()

Get all of the routes in the collection.

array

getRoutesByMethod()

Get all of the routes keyed by their HTTP verb / method.

Route[]

getRoutesByName()

Get all of the routes keyed by their name.

Details

Route add(Route $route)

Add a Route instance to the collection.

Parameters

Route

$route

Return Value

Route

void refreshNameLookups()

Refresh the name look-up table.

This is done in case any names are fluently defined or if routes are overwritten.

Return Value

void

void refreshActionLookups()

Refresh the action look-up table.

This is done in case any actions are overwritten with new controllers.

Return Value

void

Route match(Request $request)

Find the first route matching a given request.

Parameters

Request

$request

Return Value

Route

Exceptions

MethodNotAllowedHttpException
NotFoundHttpException

Route[] get(string|null $method = null)

Get routes from the collection by method.

Parameters

string|null

$method

Return Value

Route[]

bool hasNamedRoute(string $name)

Determine if the route collection contains a given named route.

Parameters

string

$name

Return Value

bool

Route|null getByName(string $name)

Get a route instance by its name.

Parameters

string

$name

Return Value

Route|null

Route|null getByAction(string $action)

Get a route instance by its controller action.

Parameters

string

$action

Return Value

Route|null

Route[] getRoutes()

Get all of the routes in the collection.

Return Value

Route[]

array getRoutesByMethod()

Get all of the routes keyed by their HTTP verb / method.

Return Value

array

Route[] getRoutesByName()

Get all of the routes keyed by their name.

Return Value

Route[]

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