vendor/symfony-cmf/routing/src/ProviderBasedGenerator.php line 58

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony CMF package.
  5.  *
  6.  * (c) 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.  */
  12. namespace Symfony\Cmf\Component\Routing;
  14. use Psr\Log\LoggerInterface;
  15. use Symfony\Component\Routing\Exception\RouteNotFoundException;
  16. use Symfony\Component\Routing\Generator\UrlGenerator;
  17. use Symfony\Component\Routing\RequestContext;
  18. use Symfony\Component\Routing\Route as SymfonyRoute;
  20. /**
  21.  * A Generator that uses a RouteProvider rather than a RouteCollection.
  22.  *
  23.  * @author Larry Garfield
  24.  */
  25. class ProviderBasedGenerator extends UrlGenerator implements VersatileGeneratorInterface
  26. {
  27.     /**
  28.      * The route provider for this generator.
  29.      *
  30.      * @var RouteProviderInterface
  31.      */
  32.     protected $provider;
  34.     /**
  35.      * @param LoggerInterface $logger
  36.      */
  37.     public function __construct(RouteProviderInterface $provider, LoggerInterface $logger = null)
  38.     {
  39.         $this->provider = $provider;
  40.         $this->logger = $logger;
  41.         $this->context = new RequestContext();
  42.     }
  44.     /**
  45.      * {@inheritdoc}
  46.      *
  47.      * The CMF routing system used to allow to pass route objects as $name to generate the route.
  48.      * Since Symfony 5.0, the UrlGeneratorInterface declares $name as string. We widen the contract
  49.      * for BC but deprecate passing non-strings.
  50.      * Instead, Pass the RouteObjectInterface::OBJECT_BASED_ROUTE_NAME as route name and the object
  51.      * in the parameters with key RouteObjectInterface::ROUTE_OBJECT.
  52.      *
  53.      * @param mixed $name
  54.      */
  55.     public function generate($name, $parameters = [], $referenceType = self::ABSOLUTE_PATH)
  56.     {
  57.         if (is_object($name)) {
  58.             @trigger_error('Passing an object as route name is deprecated since version 2.3. Pass the `RouteObjectInterface::OBJECT_BASED_ROUTE_NAME` as route name and the object in the parameters with key `RouteObjectInterface::ROUTE_OBJECT`', E_USER_DEPRECATED);
  59.         }
  60.         if ($name instanceof SymfonyRoute) {
  61.             $route = $name;
  62.         } elseif (RouteObjectInterface::OBJECT_BASED_ROUTE_NAME === $name
  63.             && array_key_exists(RouteObjectInterface::ROUTE_OBJECT, $parameters)
  64.             && $parameters[RouteObjectInterface::ROUTE_OBJECT] instanceof SymfonyRoute
  65.         ) {
  66.             $route = $parameters[RouteObjectInterface::ROUTE_OBJECT];
  67.             unset($parameters[RouteObjectInterface::ROUTE_OBJECT]);
  68.         } elseif (null === $route = $this->provider->getRouteByName($name)) {
  69.             throw new RouteNotFoundException(sprintf('Route "%s" does not exist.', $name));
  70.         }
  72.         // the Route has a cache of its own and is not recompiled as long as it does not get modified
  73.         $compiledRoute = $route->compile();
  74.         $hostTokens = $compiledRoute->getHostTokens();
  76.         $debug_message = $this->getRouteDebugMessage($name);
  78.         return $this->doGenerate($compiledRoute->getVariables(), $route->getDefaults(), $route->getRequirements(), $compiledRoute->getTokens(), $parameters, $debug_message, $referenceType, $hostTokens);
  79.     }
  81.     /**
  82.      * Support a route object and any string as route name.
  83.      *
  84.      * {@inheritdoc}
  85.      */
  86.     public function supports($name)
  87.     {
  88.         return is_string($name) || $name instanceof SymfonyRoute;
  89.     }
  91.     /**
  92.      * {@inheritdoc}
  93.      */
  94.     public function getRouteDebugMessage($name, array $parameters = [])
  95.     {
  96.         if (RouteObjectInterface::OBJECT_BASED_ROUTE_NAME === $name
  97.             && array_key_exists(RouteObjectInterface::ROUTE_OBJECT, $parameters)
  98.         ) {
  99.             $routeObject = $parameters[RouteObjectInterface::ROUTE_OBJECT];
  100.             if ($routeObject instanceof RouteObjectInterface) {
  101.                 return 'Route with key '.$routeObject->getRouteKey();
  102.             }
  104.             if ($routeObject instanceof SymfonyRoute) {
  105.                 return 'Route with path '.$routeObject->getPath();
  106.             }
  108.             if (is_object($routeObject)) {
  109.                 return get_class($routeObject);
  110.             }
  112.             return 'Null route';
  113.         }
  115.         if (is_scalar($name)) {
  116.             return $name;
  117.         }
  119.         // legacy
  120.         if (is_array($name)) {
  121.             return serialize($name);
  122.         }
  124.         if ($name instanceof RouteObjectInterface) {
  125.             return 'Route with key '.$name->getRouteKey();
  126.         }
  128.         if ($name instanceof SymfonyRoute) {
  129.             return 'Route with path '.$name->getPath();
  130.         }
  132.         if (is_object($name)) {
  133.             return get_class($name);
  134.         }
  136.         return 'Null route';
  137.     }
  138. }