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