RouteCollection
class RouteCollection implements Countable, IteratorAggregate (View source)
Properties
| protected array | $routes | An array of the routes keyed by method. |
|
| protected array | $allRoutes | An 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
Get a route (if necessary) that responds when other available methods are present.
Throw a method not allowed HTTP exception.
Determine if a route in the array matches the request.
Get all of the routes in the collection.
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 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.
protected array
checkForAlternateVerbs(Request $request)
Determine if any routes match on another HTTP verb.
protected Route
getOtherMethodsRoute(Request $request, array $others)
Get a route (if necessary) that responds when other available methods are present.
protected void
methodNotAllowed(array $others)
Throw a method not allowed HTTP exception.
protected Route|null
check(array $routes, Request $request, bool $includingMethod = true)
Determine if a route in the array matches the request.
protected array
get(string|null $method = null)
Get all of the routes in the collection.
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.
ArrayIterator
getIterator()
Get an iterator for the items.
int
count()
Count the number of items in the collection.