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

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