annotate core/lib/Drupal/Core/Routing/RouteProviderInterface.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 4c8ae668cc8c
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\Core\Routing;
Chris@0 4
Chris@0 5 use Symfony\Cmf\Component\Routing\RouteProviderInterface as RouteProviderBaseInterface;
Chris@0 6
Chris@0 7 /**
Chris@0 8 * Extends the router provider interface
Chris@0 9 *
Chris@0 10 * @see \Symfony\Cmf\Component\Routing
Chris@0 11 */
Chris@0 12 interface RouteProviderInterface extends RouteProviderBaseInterface {
Chris@0 13
Chris@0 14 /**
Chris@0 15 * Get all routes which match a certain pattern.
Chris@0 16 *
Chris@0 17 * @param string $pattern
Chris@0 18 * The route pattern to search for (contains {} as placeholders).
Chris@0 19 *
Chris@0 20 * @return \Symfony\Component\Routing\RouteCollection
Chris@0 21 * Returns a route collection of matching routes. The collection may be
Chris@0 22 * empty and will be sorted from highest to lowest fit (match of path parts)
Chris@0 23 * and then in ascending order by route name for routes with the same fit.
Chris@0 24 */
Chris@0 25 public function getRoutesByPattern($pattern);
Chris@0 26
Chris@0 27 /**
Chris@0 28 * Returns all the routes on the system.
Chris@0 29 *
Chris@0 30 * Usage of this method is discouraged for performance reasons. If possible,
Chris@0 31 * use RouteProviderInterface::getRoutesByNames() or
Chris@0 32 * RouteProviderInterface::getRoutesByPattern() instead.
Chris@0 33 *
Chris@0 34 * @return \Symfony\Component\Routing\Route[]
Chris@0 35 * An iterator of routes keyed by route name.
Chris@0 36 */
Chris@0 37 public function getAllRoutes();
Chris@0 38
Chris@0 39 /**
Chris@0 40 * Resets the route provider object.
Chris@0 41 */
Chris@0 42 public function reset();
Chris@0 43
Chris@0 44 }