Select Git revision
RouteProviderInterface.php

#2098197 by dawehner, vijaycs85, damiankloip, tstoeckler: Add...
Angie Byron authored
Issue #2098197 by dawehner, vijaycs85, damiankloip, tstoeckler: Add getAllRoutes() method to RouteProvider .
Code owners
Assign users and groups as approvers for specific file changes. Learn more.
RouteProviderInterface.php 1.11 KiB
<?php
/**
* @file
* Contains \Drupal\Core\Routing\RouteProviderInterface.
*/
namespace Drupal\Core\Routing;
use Symfony\Cmf\Component\Routing\RouteProviderInterface as RouteProviderBaseInterface;
use Symfony\Component\Routing\RouteCollection;
/**
* Extends the router provider interface
*
* @see \Symfony\Cmf\Component\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.
*/
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();
}