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

AbstractRouteCollection

abstract class AbstractRouteCollection implements Countable, IteratorAggregate, RouteCollectionInterface

Methods

Route
handleMatchedRoute(Request $request, Route|null $route)

Handle the matched route.

array
checkForAlternateVerbs(Request $request)

Determine if any routes match on another HTTP verb.

Route|null
matchAgainstRoutes(array $routes, Request $request, bool $includingMethod = true)

Determine if a route in the array matches the request.

Route
getRouteForMethods(Request $request, array $methods)

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

never
requestMethodNotAllowed(Request $request, array $others, string $method)

Throw a method not allowed HTTP exception.

array
compile()

Compile the routes for caching.

CompiledUrlMatcherDumper
dumper()

Return the CompiledUrlMatcherDumper instance for the route collection.

RouteCollection
toSymfonyRouteCollection()

Convert the collection to a Symfony RouteCollection instance.

RouteCollection
addToSymfonyRoutesCollection(RouteCollection $symfonyRoutes, Route $route)

Add a route to the SymfonyRouteCollection instance.

string
generateRouteName()

Get a randomly generated route name.

array
getWarmableRoutes()

Get the route instances that should be pre-warmed.

Traversable
getIterator()

Get an iterator for the items.

int
count()

Count the number of items in the collection.

Details

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

at line 53
protected array checkForAlternateVerbs(Request $request)

Determine if any routes match on another HTTP verb.

Parameters

Request $request

Return Value

array

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

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

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

at line 131
array compile()

Compile the routes for caching.

Return Value

array

at line 158
CompiledUrlMatcherDumper dumper()

Return the CompiledUrlMatcherDumper instance for the route collection.

Return Value

CompiledUrlMatcherDumper

at line 166
RouteCollection toSymfonyRouteCollection()

Convert the collection to a Symfony RouteCollection instance.

Return Value

RouteCollection

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

at line 222
protected string generateRouteName()

Get a randomly generated route name.

Return Value

string

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 $cachedRoutesByName that are actually used during matching, not throwaway objects from getRoutes().

Return Value

array

at line 247
Traversable getIterator()

Get an iterator for the items.

Return Value

Traversable

at line 255
int count()

Count the number of items in the collection.

Return Value

int