yaffs.net Git - yaffs-website/blob - vendor/symfony-cmf/routing/Candidates/CandidatesInterface.php

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