Mercurial > hg > isophonics-drupal-site
annotate vendor/symfony-cmf/routing/Candidates/CandidatesInterface.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 /* |
Chris@0 | 4 * This file is part of the Symfony CMF package. |
Chris@0 | 5 * |
Chris@0 | 6 * (c) 2011-2015 Symfony CMF |
Chris@0 | 7 * |
Chris@0 | 8 * For the full copyright and license information, please view the LICENSE |
Chris@0 | 9 * file that was distributed with this source code. |
Chris@0 | 10 */ |
Chris@0 | 11 |
Chris@0 | 12 namespace Symfony\Cmf\Component\Routing\Candidates; |
Chris@0 | 13 |
Chris@0 | 14 use Symfony\Component\HttpFoundation\Request; |
Chris@0 | 15 |
Chris@0 | 16 /** |
Chris@0 | 17 * Candidates is a subsystem useful for the route provider. It separates the |
Chris@0 | 18 * logic for determining possible static prefixes from the route provider. |
Chris@0 | 19 * |
Chris@0 | 20 * @author David Buchmann <mail@davidbu.ch> |
Chris@0 | 21 */ |
Chris@0 | 22 interface CandidatesInterface |
Chris@0 | 23 { |
Chris@0 | 24 /** |
Chris@0 | 25 * @param Request $request |
Chris@0 | 26 * |
Chris@0 | 27 * @return array a list of paths |
Chris@0 | 28 */ |
Chris@0 | 29 public function getCandidates(Request $request); |
Chris@0 | 30 |
Chris@0 | 31 /** |
Chris@0 | 32 * Determine if $name is a valid candidate, e.g. in getRouteByName. |
Chris@0 | 33 * |
Chris@0 | 34 * @param string $name |
Chris@0 | 35 * |
Chris@0 | 36 * @return bool |
Chris@0 | 37 */ |
Chris@0 | 38 public function isCandidate($name); |
Chris@0 | 39 |
Chris@0 | 40 /** |
Chris@0 | 41 * Provide a best effort query restriction to limit a query to only find |
Chris@0 | 42 * routes that are supported. |
Chris@0 | 43 * |
Chris@0 | 44 * @param object $queryBuilder A query builder suited for the storage backend. |
Chris@0 | 45 */ |
Chris@0 | 46 public function restrictQuery($queryBuilder); |
Chris@0 | 47 } |