interface CandidatesInterface in Zircon Profile 8

Candidates is a subsystem useful for the route provider. It separates the logic for determining possible static prefixes from the route provider.

@author David Buchmann <[e-mail]>

Hierarchy

• interface \Symfony\Cmf\Component\Routing\Candidates\CandidatesInterface

File

vendor/symfony-cmf/routing/Candidates/CandidatesInterface.php, line 22

Namespace

Symfony\Cmf\Component\Routing\Candidates

interface CandidatesInterface {

  /**
   * @param Request $request
   *
   * @return array a list of paths
   */
  public function getCandidates(Request $request);

  /**
   * Determine if $name is a valid candidate, e.g. in getRouteByName.
   *
   * @param string $name
   *
   * @return boolean
   */
  public function isCandidate($name);

  /**
   * Provide a best effort query restriction to limit a query to only find
   * routes that are supported.
   *
   * @param object $queryBuilder A query builder suited for the storage backend.
   */
  public function restrictQuery($queryBuilder);

}

Members

Name	Modifiers	Type	Description	Overrides
CandidatesInterface::getCandidates	public	function		1
CandidatesInterface::isCandidate	public	function	Determine if $name is a valid candidate, e.g. in getRouteByName.	1
CandidatesInterface::restrictQuery	public	function	Provide a best effort query restriction to limit a query to only find routes that are supported.	1