www.aleph1.co.uk Git - yaffs-website/blob - vendor/symfony-cmf/routing/VersatileGeneratorInterface.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;
  13
  14 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  15
  16 /**
  17  * This generator is able to handle more than string route names as symfony
  18  * core supports them.
  19  */
  20 interface VersatileGeneratorInterface extends UrlGeneratorInterface
  21 {
  22     /**
  23      * Whether this generator supports the supplied $name.
  24      *
  25      * This check does not need to look if the specific instance can be
  26      * resolved to a route, only whether the router can generate routes from
  27      * objects of this class.
  28      *
  29      * @param mixed $name The route "name" which may also be an object or anything
  30      *
  31      * @return bool
  32      */
  33     public function supports($name);
  34
  35     /**
  36      * Convert a route identifier (name, content object etc) into a string
  37      * usable for logging and other debug/error messages.
  38      *
  39      * @param mixed $name
  40      * @param array $parameters which should contain a content field containing
  41      *                          a RouteReferrersReadInterface object
  42      *
  43      * @return string
  44      */
  45     public function getRouteDebugMessage($name, array $parameters = array());
  46 }