W3cubDocs

/Laravel 5.4

RouteCollection

class RouteCollection implements Countable, IteratorAggregate (View source)

Methods

Route add(Route $route)

Add a Route instance to the collection.

void refreshNameLookups()

Refresh the name 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.

ArrayIterator getIterator()

Get an iterator for the items.

int count()

Count the number of items in the collection.

Details

Route add(Route $route)

Add a Route instance to the collection.

Parameters

Route $route

Return Value

Route

void refreshNameLookups()

Refresh the name look-up table.

This is done in case any names are fluently defined.

Return Value

void

Route match(Request $request)

Find the first route matching a given request.

Parameters

Request $request

Return Value

Route

Exceptions

NotFoundHttpException

array get(string|null $method = null)

Get routes from the collection by method.

Parameters

string|null $method

Return Value

array

bool hasNamedRoute(string $name)

Determine if the route collection contains a given named route.

Parameters

string $name

Return Value

bool

Route|null getByName(string $name)

Get a route instance by its name.

Parameters

string $name

Return Value

Route|null

Route|null getByAction(string $action)

Get a route instance by its controller action.

Parameters

string $action

Return Value

Route|null

array getRoutes()

Get all of the routes in the collection.

Return Value

array

array getRoutesByMethod()

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

Return Value

array

ArrayIterator getIterator()

Get an iterator for the items.

Return Value

ArrayIterator

int count()

Count the number of items in the collection.

Return Value

int

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.4/Illuminate/Routing/RouteCollection.html