vendor/pimcore/pimcore/lib/Routing/DynamicRouteProvider.php line 84

Open in your IDE?
  1. <?php
  3. /**
  4.  * Pimcore
  5.  *
  6.  * This source file is available under two different licenses:
  7.  * - GNU General Public License version 3 (GPLv3)
  8.  * - Pimcore Commercial License (PCL)
  9.  * Full copyright and license information is available in
  10.  * LICENSE.md which is distributed with this source code.
  11.  *
  12.  *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  13.  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  14.  */
  16. namespace Pimcore\Routing;
  18. use Pimcore\Http\Request\Resolver\SiteResolver;
  19. use Pimcore\Routing\Dynamic\DynamicRequestContext;
  20. use Pimcore\Routing\Dynamic\DynamicRouteHandlerInterface;
  21. use Symfony\Cmf\Component\Routing\RouteProviderInterface;
  22. use Symfony\Component\HttpFoundation\Request;
  23. use Symfony\Component\Routing\Exception\RouteNotFoundException;
  24. use Symfony\Component\Routing\Route;
  25. use Symfony\Component\Routing\RouteCollection;
  27. /**
  28.  * @internal
  29.  */
  30. final class DynamicRouteProvider implements RouteProviderInterface
  31. {
  32.     /**
  33.      * @var SiteResolver
  34.      */
  35.     protected $siteResolver;
  37.     /**
  38.      * @var DynamicRouteHandlerInterface[]
  39.      */
  40.     protected $handlers = [];
  42.     /**
  43.      * @param SiteResolver $siteResolver
  44.      * @param DynamicRouteHandlerInterface[] $handlers
  45.      */
  46.     public function __construct(SiteResolver $siteResolver, array $handlers = [])
  47.     {
  48.         $this->siteResolver = $siteResolver;
  50.         foreach ($handlers as $handler) {
  51.             $this->addHandler($handler);
  52.         }
  53.     }
  55.     /**
  56.      * @param DynamicRouteHandlerInterface $handler
  57.      */
  58.     public function addHandler(DynamicRouteHandlerInterface $handler)
  59.     {
  60.         if (!in_array($handler, $this->handlers, true)) {
  61.             $this->handlers[] = $handler;
  62.         }
  63.     }
  65.     /**
  66.      * {@inheritdoc}
  67.      */
  68.     public function getRouteCollectionForRequest(Request $request): RouteCollection
  69.     {
  70.         $collection = new RouteCollection();
  72.         if ($request->attributes->has('_controller')) {
  73.             return $collection;
  74.         }
  76.         $path = $originalPath = urldecode($request->getPathInfo());
  78.         // site path handled by FrontendRoutingListener which runs before routing is started
  79.         if (null !== $sitePath = $this->siteResolver->getSitePath($request)) {
  80.             $path = $sitePath;
  81.         }
  83.         foreach ($this->handlers as $handler) {
  84.             $handler->matchRequest($collection, new DynamicRequestContext($request, $path, $originalPath));
  85.         }
  87.         return $collection;
  88.     }
  90.     /**
  91.      * {@inheritdoc}
  92.      */
  93.     public function getRouteByName($name): Route
  94.     {
  95.         foreach ($this->handlers as $handler) {
  96.             try {
  97.                 return $handler->getRouteByName($name);
  98.             } catch (RouteNotFoundException $e) {
  99.                 // noop
  100.             }
  101.         }
  103.         throw new RouteNotFoundException(sprintf("Route for name '%s' was not found", $name));
  104.     }
  106.     /**
  107.      * {@inheritdoc}
  108.      */
  109.     public function getRoutesByNames($names): array
  110.     {
  111.         // TODO needs performance optimizations
  112.         // TODO really return all routes here as documentation states? where is this used?
  113.         $routes = [];
  115.         if (is_array($names)) {
  116.             foreach ($names as $name) {
  117.                 try {
  118.                     $route = $this->getRouteByName($name);
  119.                     $routes[] = $route;
  120.                 } catch (RouteNotFoundException $e) {
  121.                     // noop
  122.                 }
  123.             }
  124.         }
  126.         return $routes;
  127.     }
  128. }