1. class
  2. Hypervel
  3. \
  4. Routing
  5. \
  6. RouteCollection

RouteCollection

class RouteCollection extends AbstractRouteCollection

Properties

protected Route>> $routes

An array of the routes keyed by method.
protected Route>> $domainRoutes

Domain routes keyed by method, used to maintain domain-first ordering.
protected Route> $allRoutes

A flattened array of all of the routes.
protected Route> $allDomainRoutes

Domain routes in the flattened array, used to maintain domain-first ordering.
protected Route> $nameList

A look-up table of routes by their names.
protected Route> $actionList

A look-up table of routes by controller action.

Methods

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
never
requestMethodNotAllowed(Request $request, 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
array
getWarmableRoutes()

Get the route instances that should be pre-warmed.

from  AbstractRouteCollection
Traversable
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.

bool
inActionLookup(string $controller)

Determine if the given controller is in the action lookup table.

bool
inNameLookup(string $name)

Determine if the given name is in the name lookup table.

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.

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.

CompiledRouteCollection
toCompiledRouteCollection(Router $router, Container $container)

Convert the collection to a CompiledRouteCollection instance.

Details

in AbstractRouteCollection at line 27
protected Route handleMatchedRoute(Request $request, Route|null $route)

Handle the matched route.

Parameters

Request $request
Route|null $route

Return Value

Route

Exceptions

NotFoundHttpException

in AbstractRouteCollection at line 53
protected array checkForAlternateVerbs(Request $request)

Determine if any routes match on another HTTP verb.

Parameters

Request $request

Return Value

array

in AbstractRouteCollection at line 73
protected Route|null matchAgainstRoutes(array $routes, Request $request, bool $includingMethod = true)

Determine if a route in the array matches the request.

Parameters

array $routes
Request $request
bool $includingMethod

Return Value

Route|null

in AbstractRouteCollection at line 99
protected Route getRouteForMethods(Request $request, array $methods)

Get a route (if necessary) that responds when other available methods are present.

Parameters

Request $request
array $methods

Return Value

Route

Exceptions

MethodNotAllowedHttpException

in AbstractRouteCollection at line 115
protected never requestMethodNotAllowed(Request $request, array $others, string $method)

Throw a method not allowed HTTP exception.

Parameters

Request $request
array $others
string $method

Return Value

never

Exceptions

MethodNotAllowedHttpException

in AbstractRouteCollection at line 131
array compile()

Compile the routes for caching.

Return Value

array

in AbstractRouteCollection at line 158
CompiledUrlMatcherDumper dumper()

Return the CompiledUrlMatcherDumper instance for the route collection.

Return Value

CompiledUrlMatcherDumper

at line 283
RouteCollection toSymfonyRouteCollection()

Convert the collection to a Symfony RouteCollection instance.

Return Value

RouteCollection

in AbstractRouteCollection at line 194
protected RouteCollection addToSymfonyRoutesCollection(RouteCollection $symfonyRoutes, Route $route)

Add a route to the SymfonyRouteCollection instance.

Parameters

RouteCollection $symfonyRoutes
Route $route

Return Value

RouteCollection

Exceptions

LogicException

in AbstractRouteCollection at line 222
protected string generateRouteName()

Get a randomly generated route name.

Return Value

string

in AbstractRouteCollection at line 237
array getWarmableRoutes()

Get the route instances that should be pre-warmed.

For RouteCollection, this is the same as getRoutes(). For CompiledRouteCollection, this returns the cached Route instances from $nameCache that are actually used during matching, not throwaway objects from getRoutes().

Return Value

array

in AbstractRouteCollection at line 247
Traversable getIterator()

Get an iterator for the items.

Return Value

Traversable

in AbstractRouteCollection at line 255
int count()

Count the number of items in the collection.

Return Value

int

at line 61
Route add(Route $route)

Add a Route instance to the collection.

Parameters

Route $route

Return Value

Route

at line 73
protected void addToCollections(Route $route)

Add the given route to the arrays of routes.

Parameters

Route $route

Return Value

void

at line 115
protected void addLookups(Route $route)

Add the route to any look-up tables if necessary.

Parameters

Route $route

Return Value

void

at line 137
protected void addToActionList(array $action, Route $route)

Add a route to the controller action dictionary.

Parameters

array $action
Route $route

Return Value

void

at line 145
protected bool inActionLookup(string $controller)

Determine if the given controller is in the action lookup table.

Parameters

string $controller

Return Value

bool

at line 153
protected bool inNameLookup(string $name)

Determine if the given name is in the name lookup table.

Parameters

string $name

Return Value

bool

at line 163
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

at line 179
void refreshActionLookups()

Refresh the action look-up table.

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

Return Value

void

at line 196
Route match(Request $request)

Find the first route matching a given request.

Parameters

Request $request

Return Value

Route

Exceptions

MethodNotAllowedHttpException
NotFoundHttpException

at line 213
array get(string|null $method = null)

Get routes from the collection by method.

Parameters

string|null $method

Return Value

array

at line 223
bool hasNamedRoute(string $name)

Determine if the route collection contains a given named route.

Parameters

string $name

Return Value

bool

at line 231
Route|null getByName(string $name)

Get a route instance by its name.

Parameters

string $name

Return Value

Route|null

at line 239
Route|null getByAction(string $action)

Get a route instance by its controller action.

Parameters

string $action

Return Value

Route|null

at line 249
array getRoutes()

Get all of the routes in the collection.

Return Value

array

at line 259
array getRoutesByMethod()

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

Return Value

array

at line 275
array getRoutesByName()

Get all of the routes keyed by their name.

Return Value

array

at line 295
CompiledRouteCollection toCompiledRouteCollection(Router $router, Container $container)

Convert the collection to a CompiledRouteCollection instance.

Parameters

Router $router
Container $container

Return Value

CompiledRouteCollection