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\Candidates;
Chris@0: 
Chris@0: use Symfony\Component\HttpFoundation\Request;
Chris@0: 
Chris@0: /**
Chris@0:  * Candidates is a subsystem useful for the route provider. It separates the
Chris@0:  * logic for determining possible static prefixes from the route provider.
Chris@0:  *
Chris@0:  * @author David Buchmann <mail@davidbu.ch>
Chris@0:  */
Chris@0: interface CandidatesInterface
Chris@0: {
Chris@0:     /**
Chris@0:      * @param Request $request
Chris@0:      *
Chris@0:      * @return array a list of paths
Chris@0:      */
Chris@0:     public function getCandidates(Request $request);
Chris@0: 
Chris@0:     /**
Chris@0:      * Determine if $name is a valid candidate, e.g. in getRouteByName.
Chris@0:      *
Chris@0:      * @param string $name
Chris@0:      *
Chris@0:      * @return bool
Chris@0:      */
Chris@0:     public function isCandidate($name);
Chris@0: 
Chris@0:     /**
Chris@0:      * Provide a best effort query restriction to limit a query to only find
Chris@0:      * routes that are supported.
Chris@0:      *
Chris@0:      * @param object $queryBuilder A query builder suited for the storage backend.
Chris@0:      */
Chris@0:     public function restrictQuery($queryBuilder);
Chris@0: }