interface RouteProviderInterface in Drupal 8

Extends the router provider interface

Hierarchy

• interface \Drupal\Core\Routing\RouteProviderInterface extends \Symfony\Cmf\Component\Routing\RouteProviderInterface

See also

\Symfony\Cmf\Component\Routing

30 files declare their use of RouteProviderInterface

AccessManager.php in core/lib/Drupal/Core/Access/AccessManager.php

BlockEntityOffCanvasFormRouteProcessorBC.php in core/modules/settings_tray/src/RouteProcessor/BlockEntityOffCanvasFormRouteProcessorBC.php

ConfigEntityMapper.php in core/modules/config_translation/src/ConfigEntityMapper.php

ConfigNamesMapper.php in core/modules/config_translation/src/ConfigNamesMapper.php

Feed.php in core/modules/views/src/Plugin/views/display/Feed.php

... See full list

File

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

Namespace

Drupal\Core\Routing

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. The collection may be
   *   empty and will be sorted from highest to lowest fit (match of path parts)
   *   and then in ascending order by route name for routes with the same fit.
   */
  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

Name	Modifiers	Type	Description	Overrides
RouteProviderInterface::getAllRoutes	public	function	Returns all the routes on the system.	4
RouteProviderInterface::getRoutesByPattern	public	function	Get all routes which match a certain pattern.	4
RouteProviderInterface::reset	public	function	Resets the route provider object.	4