You are here

interface RouteProviderInterface in Zircon Profile 8.0

Same name in this branch
  1. 8.0 vendor/symfony-cmf/routing/RouteProviderInterface.php \Symfony\Cmf\Component\Routing\RouteProviderInterface
  2. 8.0 core/lib/Drupal/Core/Routing/RouteProviderInterface.php \Drupal\Core\Routing\RouteProviderInterface
Same name and namespace in other branches
  1. 8 core/lib/Drupal/Core/Routing/RouteProviderInterface.php \Drupal\Core\Routing\RouteProviderInterface

Extends the router provider interface

Hierarchy

Expanded class hierarchy of RouteProviderInterface

All classes that implement RouteProviderInterface

See also

\Symfony\Cmf\Component\Routing

19 files declare their use of RouteProviderInterface
AccessManager.php in core/lib/Drupal/Core/Access/AccessManager.php
Contains \Drupal\Core\Access\AccessManager.
ConfigEntityMapper.php in core/modules/config_translation/src/ConfigEntityMapper.php
Contains \Drupal\config_translation\ConfigEntityMapper.
ConfigNamesMapper.php in core/modules/config_translation/src/ConfigNamesMapper.php
Contains \Drupal\config_translation\ConfigNamesMapper.
FieldUiLocalAction.php in core/modules/field_ui/src/Plugin/Derivative/FieldUiLocalAction.php
Contains \Drupal\field_ui\Plugin\Derivative\FieldUiLocalAction.
FieldUiLocalTask.php in core/modules/field_ui/src/Plugin/Derivative/FieldUiLocalTask.php
Contains \Drupal\field_ui\Plugin\Derivative\FieldUiLocalTask.

... See full list

File

core/lib/Drupal/Core/Routing/RouteProviderInterface.php, line 17
Contains \Drupal\Core\Routing\RouteProviderInterface.

Namespace

Drupal\Core\Routing
View source
interface RouteProviderInterface extends RouteProviderBaseInterface {

  /**
   * Get all routes which match a certain pattern.
   *
   * @param string $pattern
   *   The route pattern to search for (contains {} as placeholders).
   *
   * @return \Symfony\Component\Routing\RouteCollection
   *   Returns a route collection of matching routes.
   */
  public function getRoutesByPattern($pattern);

  /**
   * Returns all the routes on the system.
   *
   * Usage of this method is discouraged for performance reasons. If possible,
   * use RouteProviderInterface::getRoutesByNames() or
   * RouteProviderInterface::getRoutesByPattern() instead.
   *
   * @return \Symfony\Component\Routing\Route[]
   *   An iterator of routes keyed by route name.
   */
  public function getAllRoutes();

  /**
   * Resets the route provider object.
   */
  public function reset();

}

Members

Namesort descending Modifiers Type Description Overrides
RouteProviderInterface::getAllRoutes public function Returns all the routes on the system. 2
RouteProviderInterface::getRouteByName public function Find the route using the provided route name. 2
RouteProviderInterface::getRouteCollectionForRequest public function Finds routes that may potentially match the request. 2
RouteProviderInterface::getRoutesByNames public function Find many routes by their names using the provided list of names. 2
RouteProviderInterface::getRoutesByPattern public function Get all routes which match a certain pattern. 2
RouteProviderInterface::reset public function Resets the route provider object. 2