class RouteCollection extends AbstractRouteCollection (View source)
protected array | $routes | An array of the routes keyed by method. | |
protected Route[] | $allRoutes | A flattened array of all of the routes. | |
protected Route[] | $nameList | A look-up table of routes by their names. | |
protected Route[] | $actionList | A look-up table of routes by controller action. |
Route | handleMatchedRoute(Request $request, Route|null $route) Handle the matched route. | from AbstractRouteCollection |
array | checkForAlternateVerbs(Request $request) Determine if any routes match on another HTTP verb. | from AbstractRouteCollection |
Route|null | matchAgainstRoutes(array $routes, Request $request, bool $includingMethod = true) Determine if a route in the array matches the request. | from AbstractRouteCollection |
Route | getRouteForMethods(Request $request, array $methods) Get a route (if necessary) that responds when other available methods are present. | from AbstractRouteCollection |
void | methodNotAllowed(array $others, string $method) Throw a method not allowed HTTP exception. | from AbstractRouteCollection |
array | compile() Compile the routes for caching. | from AbstractRouteCollection |
CompiledUrlMatcherDumper | dumper() Return the CompiledUrlMatcherDumper instance for the route collection. | from AbstractRouteCollection |
RouteCollection | toSymfonyRouteCollection() Convert the collection to a Symfony RouteCollection instance. | |
RouteCollection | addToSymfonyRoutesCollection(RouteCollection $symfonyRoutes, Route $route) Add a route to the SymfonyRouteCollection instance. | from AbstractRouteCollection |
string | generateRouteName() Get a randomly generated route name. | from AbstractRouteCollection |
ArrayIterator | getIterator() Get an iterator for the items. | from AbstractRouteCollection |
int | count() Count the number of items in the collection. | from AbstractRouteCollection |
Route | add(Route $route) Add a Route instance to the collection. | |
void | addToCollections(Route $route) Add the given route to the arrays of routes. | |
void | addLookups(Route $route) Add the route to any look-up tables if necessary. | |
void | addToActionList(array $action, Route $route) Add a route to the controller action dictionary. | |
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. | |
CompiledRouteCollection | toCompiledRouteCollection(Router $router, Container $container) Convert the collection to a CompiledRouteCollection instance. |
Determine if any routes match on another HTTP verb.
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.
Compile the routes for caching.
Return the CompiledUrlMatcherDumper instance for the route collection.
Convert the collection to a Symfony RouteCollection instance.
Add a route to the SymfonyRouteCollection instance.
Get a randomly generated route name.
Get an iterator for the items.
Count the number of items in the collection.
Add the given route to the arrays of routes.
Add the route to any look-up tables if necessary.
Add a route to the controller action dictionary.
Refresh the name look-up table.
This is done in case any names are fluently defined or if routes are overwritten.
Refresh the action look-up table.
This is done in case any actions are overwritten with new controllers.
Get routes from the collection by method.
Determine if the route collection contains a given named route.
Get a route instance by its name.
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.
Convert the collection to a CompiledRouteCollection instance.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Routing/RouteCollection.html