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

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\RouteCollection;
  26. /**
  27. * @internal
  28. */
  29. final class DynamicRouteProvider implements RouteProviderInterface
  30. {
  31. /**
  32. * @var SiteResolver
  33. */
  34. protected $siteResolver;
  36. /**
  37. * @var DynamicRouteHandlerInterface[]
  38. */
  39. protected $handlers = [];
  41. /**
  42. * @param SiteResolver $siteResolver
  43. * @param DynamicRouteHandlerInterface[] $handlers
  44. */
  45. public function __construct(SiteResolver $siteResolver, array $handlers = [])
  46. {
  47. $this->siteResolver = $siteResolver;
  49. foreach ($handlers as $handler) {
  50. $this->addHandler($handler);
  51. }
  52. }
  54. /**
  55. * @param DynamicRouteHandlerInterface $handler
  56. */
  57. public function addHandler(DynamicRouteHandlerInterface $handler)
  58. {
  59. if (!in_array($handler, $this->handlers, true)) {
  60. $this->handlers[] = $handler;
  61. }
  62. }
  64. /**
  65. * {@inheritdoc}
  66. */
  67. public function getRouteCollectionForRequest(Request $request)
  68. {
  69. $collection = new RouteCollection();
  70. $path = $originalPath = urldecode($request->getPathInfo());
  72. // site path handled by FrontendRoutingListener which runs before routing is started
  73. if (null !== $sitePath = $this->siteResolver->getSitePath($request)) {
  74. $path = $sitePath;
  75. }
  77. foreach ($this->handlers as $handler) {
  78. $handler->matchRequest($collection, new DynamicRequestContext($request, $path, $originalPath));
  79. }
  81. return $collection;
  82. }
  84. /**
  85. * {@inheritdoc}
  86. */
  87. public function getRouteByName($name)
  88. {
  89. foreach ($this->handlers as $handler) {
  90. try {
  91. return $handler->getRouteByName($name);
  92. } catch (RouteNotFoundException $e) {
  93. // noop
  94. }
  95. }
  97. throw new RouteNotFoundException(sprintf("Route for name '%s' was not found", $name));
  98. }
  100. /**
  101. * {@inheritdoc}
  102. */
  103. public function getRoutesByNames($names)
  104. {
  105. // TODO needs performance optimizations
  106. // TODO really return all routes here as documentation states? where is this used?
  107. $routes = [];
  109. if (is_array($names)) {
  110. foreach ($names as $name) {
  111. try {
  112. $route = $this->getRouteByName($name);
  113. $routes[] = $route;
  114. } catch (RouteNotFoundException $e) {
  115. // noop
  116. }
  117. }
  118. }
  120. return $routes;
  121. }
  122. }