vendor/symfony-cmf/routing-bundle/src/Routing/DynamicRouter.php line 69

  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\Bundle\RoutingBundle\Routing;
  14. use Symfony\Cmf\Component\Routing\DynamicRouter as BaseDynamicRouter;
  15. use Symfony\Cmf\Component\Routing\RouteObjectInterface;
  16. use Symfony\Component\HttpFoundation\Request;
  17. use Symfony\Component\HttpFoundation\RequestStack;
  18. use Symfony\Component\Routing\Exception\ResourceNotFoundException;
  20. /**
  21.  * Symfony framework integration of the CMF routing component DynamicRouter class.
  22.  *
  23.  * @author Filippo de Santis
  24.  * @author David Buchmann
  25.  * @author Lukas Smith
  26.  * @author Nacho Martìn
  27.  */
  28. class DynamicRouter extends BaseDynamicRouter
  29. {
  30.     /**
  31.      * key for the request attribute that contains the route document.
  32.      */
  33.     public const ROUTE_KEY = 'routeDocument';
  35.     /**
  36.      * key for the request attribute that contains the content document if this
  37.      * route has one associated.
  38.      */
  39.     public const CONTENT_KEY = 'contentDocument';
  41.     /**
  42.      * key for the request attribute that contains the template this document
  43.      * wants to use.
  44.      */
  45.     public const CONTENT_TEMPLATE = 'template';
  47.     private RequestStack $requestStack;
  49.     /**
  50.      * Put content and template name into the request attributes instead of the
  51.      * route defaults.
  52.      *
  53.      * {@inheritdoc}
  54.      *
  55.      * The match should identify  a controller for symfony. This can either be
  56.      * the fully qualified class name or the service name of a controller that
  57.      * is registered as a service. In both cases, the action to call on that
  58.      * controller is appended, separated with two colons.
  59.      */
  60.     public function match(string $url): array
  61.     {
  62.         $defaults = parent::match($url);
  64.         return $this->cleanDefaults($defaults);
  65.     }
  67.     public function matchRequest(Request $request): array
  68.     {
  69.         $defaults = parent::matchRequest($request);
  71.         return $this->cleanDefaults($defaults, $request);
  72.     }
  74.     /**
  75.      * Clean up the match data and move some values into the request attributes.
  76.      *
  77.      * @param array<string, string> $defaults The defaults from the match
  78.      * @param Request|null          $request  The request object if available
  79.      *
  80.      * @return array<string, string> the updated defaults to return for this match
  81.      */
  82.     protected function cleanDefaults(array $defaults, Request $request = null): array
  83.     {
  84.         if (null === $request) {
  85.             $request = $this->getRequest();
  86.         }
  88.         if (\array_key_exists(RouteObjectInterface::ROUTE_OBJECT, $defaults)) {
  89.             $request->attributes->set(self::ROUTE_KEY, $defaults[RouteObjectInterface::ROUTE_OBJECT]);
  90.             unset($defaults[RouteObjectInterface::ROUTE_OBJECT]);
  91.         }
  93.         if (\array_key_exists(RouteObjectInterface::CONTENT_OBJECT, $defaults)) {
  94.             $request->attributes->set(self::CONTENT_KEY, $defaults[RouteObjectInterface::CONTENT_OBJECT]);
  95.             unset($defaults[RouteObjectInterface::CONTENT_OBJECT]);
  96.         }
  98.         if (\array_key_exists(RouteObjectInterface::TEMPLATE_NAME, $defaults)) {
  99.             $request->attributes->set(self::CONTENT_TEMPLATE, $defaults[RouteObjectInterface::TEMPLATE_NAME]);
  101.             unset($defaults[RouteObjectInterface::TEMPLATE_NAME]);
  102.         }
  104.         return $defaults;
  105.     }
  107.     /**
  108.      * Set the request stack so that we can find the current request.
  109.      */
  110.     public function setRequestStack(RequestStack $requestStack): void
  111.     {
  112.         $this->requestStack = $requestStack;
  113.     }
  115.     /**
  116.      * Get the current request from the request stack.
  117.      *
  118.      * @throws ResourceNotFoundException
  119.      */
  120.     public function getRequest(): Request
  121.     {
  122.         $currentRequest = $this->requestStack->getCurrentRequest();
  123.         if (!$currentRequest) {
  124.             throw new ResourceNotFoundException('There is no request in the request stack');
  125.         }
  127.         return $currentRequest;
  128.     }
  129. }