Chris@0: <?php
Chris@0: 
Chris@0: /*
Chris@0:  * This file is part of the Symfony CMF package.
Chris@0:  *
Chris@0:  * (c) 2011-2015 Symfony CMF
Chris@0:  *
Chris@0:  * For the full copyright and license information, please view the LICENSE
Chris@0:  * file that was distributed with this source code.
Chris@0:  */
Chris@0: 
Chris@0: namespace Symfony\Cmf\Component\Routing;
Chris@0: 
Chris@0: use Symfony\Component\HttpFoundation\Request;
Chris@0: use Symfony\Component\Routing\Exception\RouteNotFoundException;
Chris@0: use Symfony\Component\Routing\Route;
Chris@0: use Symfony\Component\Routing\RouteCollection;
Chris@0: 
Chris@0: /**
Chris@0:  * Interface for the route provider the DynamicRouter is using.
Chris@0:  *
Chris@0:  * Typically this could be a doctrine orm or odm repository, but you can
Chris@0:  * implement something else if you need to.
Chris@0:  */
Chris@0: interface RouteProviderInterface
Chris@0: {
Chris@0:     /**
Chris@0:      * Finds routes that may potentially match the request.
Chris@0:      *
Chris@0:      * This may return a mixed list of class instances, but all routes returned
Chris@0:      * must extend the core symfony route. The classes may also implement
Chris@0:      * RouteObjectInterface to link to a content document.
Chris@0:      *
Chris@0:      * This method may not throw an exception based on implementation specific
Chris@0:      * restrictions on the url. That case is considered a not found - returning
Chris@0:      * an empty array. Exceptions are only used to abort the whole request in
Chris@0:      * case something is seriously broken, like the storage backend being down.
Chris@0:      *
Chris@0:      * Note that implementations may not implement an optimal matching
Chris@0:      * algorithm, simply a reasonable first pass.  That allows for potentially
Chris@0:      * very large route sets to be filtered down to likely candidates, which
Chris@0:      * may then be filtered in memory more completely.
Chris@0:      *
Chris@0:      * @param Request $request A request against which to match.
Chris@0:      *
Chris@0:      * @return RouteCollection with all Routes that could potentially match
Chris@0:      *                         $request. Empty collection if nothing can match.
Chris@0:      */
Chris@0:     public function getRouteCollectionForRequest(Request $request);
Chris@0: 
Chris@0:     /**
Chris@0:      * Find the route using the provided route name.
Chris@0:      *
Chris@0:      * @param string $name The route name to fetch.
Chris@0:      *
Chris@0:      * @return Route
Chris@0:      *
Chris@0:      * @throws RouteNotFoundException If there is no route with that name in
Chris@0:      *                                this repository
Chris@0:      */
Chris@0:     public function getRouteByName($name);
Chris@0: 
Chris@0:     /**
Chris@0:      * Find many routes by their names using the provided list of names.
Chris@0:      *
Chris@0:      * Note that this method may not throw an exception if some of the routes
Chris@0:      * are not found or are not actually Route instances. It will just return the
Chris@0:      * list of those Route instances it found.
Chris@0:      *
Chris@0:      * This method exists in order to allow performance optimizations. The
Chris@0:      * simple implementation could be to just repeatedly call
Chris@0:      * $this->getRouteByName() while catching and ignoring eventual exceptions.
Chris@0:      *
Chris@0:      * If $names is null, this method SHOULD return a collection of all routes
Chris@0:      * known to this provider. If there are many routes to be expected, usage of
Chris@0:      * a lazy loading collection is recommended. A provider MAY only return a
Chris@0:      * subset of routes to e.g. support paging or other concepts, but be aware
Chris@0:      * that the DynamicRouter will only call this method once per
Chris@0:      * DynamicRouter::getRouteCollection() call.
Chris@0:      *
Chris@0:      * @param array|null $names The list of names to retrieve, In case of null,
Chris@0:      *                          the provider will determine what routes to return.
Chris@0:      *
Chris@0:      * @return Route[] Iterable list with the keys being the names from the
Chris@0:      *                 $names array.
Chris@0:      */
Chris@0:     public function getRoutesByNames($names);
Chris@0: }