RouteCollection
class RouteCollection implements Countable, IteratorAggregate (View source)
Properties
| protected array | $routes | An array of the routes keyed by method. |
|
| protected array | $allRoutes | A flattened array of all of the routes. |
|
| protected array | $nameList | A look-up table of routes by their names. |
|
| protected array | $actionList | A look-up table of routes by controller action. |
Methods
Refresh the name look-up table.
Refresh the action look-up table.
Determine if a route in the array matches the request.
Get a route (if necessary) that responds when other available methods are present.
Throw a method not allowed HTTP exception.
Get routes from the collection by method.
Determine if the route collection contains a given named route.
Get a route instance by its controller action.
Get all of the routes in the collection.
Get all of the routes keyed by their HTTP verb / method.
Get all of the routes keyed by their name.
Get an iterator for the items.
Count the number of items in the collection.
Details
protected void
addToCollections(Route $route)
Add the given route to the arrays of routes.
protected void
addLookups(Route $route)
Add the route to any look-up tables if necessary.
protected void
addToActionList(array $action, Route $route)
Add a route to the controller action dictionary.
void
refreshNameLookups()
Refresh the name look-up table.
This is done in case any names are fluently defined or if routes are overwritten.
void
refreshActionLookups()
Refresh the action look-up table.
This is done in case any actions are overwritten with new controllers.
protected Route|null
matchAgainstRoutes(array $routes, Request $request, bool $includingMethod = true)
Determine if a route in the array matches the request.
protected array
checkForAlternateVerbs(Request $request)
Determine if any routes match on another HTTP verb.
protected Route
getRouteForMethods(Request $request, array $methods)
Get a route (if necessary) that responds when other available methods are present.
protected void
methodNotAllowed(array $others, string $method)
Throw a method not allowed HTTP exception.
array
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.
array
getRoutes()
Get all of the routes in the collection.
array
getRoutesByMethod()
Get all of the routes keyed by their HTTP verb / method.
array
getRoutesByName()
Get all of the routes keyed by their name.
ArrayIterator
getIterator()
Get an iterator for the items.
int
count()
Count the number of items in the collection.
Laravel Cloud is the best place to deploy Laravel, Nuxt, Express, Hono, Node.js, Bun, Go, Flask, Python, and more, with dedicated infrastructure available on AWS through Laravel Private Cloud.