function RouteProviderInterface::getRoutesByNames

Same name in other branches
  1. 10 core/lib/Drupal/Core/Routing/RouteProviderInterface.php \Drupal\Core\Routing\RouteProviderInterface::getRoutesByNames()
  2. 11.x core/lib/Drupal/Core/Routing/RouteProviderInterface.php \Drupal\Core\Routing\RouteProviderInterface::getRoutesByNames()

Find many routes by their names using the provided list of names.

Note that this method may not throw an exception if some of the routes are not found or are not actually Route instances. It will just return the list of those Route instances it found.

This method exists in order to allow performance optimizations. The simple implementation could be to just repeatedly call $this->getRouteByName() while catching and ignoring eventual exceptions.

If $names is null, this method SHOULD return a collection of all routes known to this provider. If there are many routes to be expected, usage of a lazy loading collection is recommended. A provider MAY only return a subset of routes to e.g. support paging or other concepts.

Parameters

array|null $names: The list of names to retrieve, In case of null, the provider will determine what routes to return

Return value

\Symfony\Component\Routing\Route[] Iterable list with the keys being the names from the $names array

4 methods override RouteProviderInterface::getRoutesByNames()
MockRouteProvider::getRoutesByNames in core/modules/system/src/Tests/Routing/MockRouteProvider.php
Find many routes by their names using the provided list of names.
RouteProvider::getRoutesByNames in core/tests/Drupal/KernelTests/RouteProvider.php
Find many routes by their names using the provided list of names.
RouteProvider::getRoutesByNames in core/lib/Drupal/Core/Routing/RouteProvider.php
Find many routes by their names using the provided list of names.
RouteProviderLazyBuilder::getRoutesByNames in core/lib/Drupal/Core/Routing/RouteProviderLazyBuilder.php
Find many routes by their names using the provided list of names.

File

core/lib/Drupal/Core/Routing/RouteProviderInterface.php, line 78

Class

RouteProviderInterface
Extends the router provider interface.

Namespace

Drupal\Core\Routing

Code

public function getRoutesByNames($names);

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.