vendor/se7enxweb/legacy-bridge/bundle/Routing/FallbackRouter.php line 37

Open in your IDE?
  1. <?php
  3. /**
  4. * @copyright Copyright (C) eZ Systems AS. All rights reserved.
  5. * @license For full copyright and license information view LICENSE file distributed with this source code.
  6. */
  7. namespace eZ\Bundle\EzPublishLegacyBundle\Routing;
  9. use Symfony\Component\Routing\RouterInterface;
  10. use Symfony\Component\Routing\RequestContext;
  11. use Symfony\Component\Routing\RouteCollection;
  12. use Symfony\Component\HttpFoundation\Request;
  13. use Symfony\Component\Routing\Matcher\RequestMatcherInterface;
  14. use Symfony\Component\Routing\Exception\RouteNotFoundException;
  15. use Psr\Log\LoggerInterface;
  16. use RuntimeException;
  18. class FallbackRouter implements RouterInterface, RequestMatcherInterface
  19. {
  20. const ROUTE_NAME = 'ez_legacy';
  22. /**
  23. * @var \Symfony\Component\Routing\RequestContext
  24. */
  25. private $context;
  27. /**
  28. * @var \Psr\Log\LoggerInterface
  29. */
  30. private $logger;
  32. /**
  33. * @var UrlGenerator
  34. */
  35. private $urlGenerator;
  37. public function __construct(UrlGenerator $urlGenerator, RequestContext $context = null, LoggerInterface $logger = null)
  38. {
  39. $this->urlGenerator = $urlGenerator;
  40. $this->context = $context = $context ?: new RequestContext();
  41. $this->logger = $logger;
  42. }
  44. /**
  45. * Sets the request context.
  46. *
  47. * @param \Symfony\Component\Routing\RequestContext $context The context
  48. */
  49. public function setContext(RequestContext $context)
  50. {
  51. $this->context = $context;
  52. }
  54. /**
  55. * Gets the request context.
  56. *
  57. * @return \Symfony\Component\Routing\RequestContext The context
  58. */
  59. public function getContext()
  60. {
  61. return $this->context;
  62. }
  64. /**
  65. * Gets the RouteCollection instance associated with this Router.
  66. *
  67. * @return RouteCollection A RouteCollection instance
  68. */
  69. public function getRouteCollection()
  70. {
  71. // No route registered for legacy fallback, request will be forwarded directly to the legacy kernel
  72. return new RouteCollection();
  73. }
  75. /**
  76. * Generates a URL for an eZ Publish legacy fallback route, from the given parameters.
  77. * "module_uri" must be provided as a key in $parameters. The module URI must contain ordered parameters if any
  78. * (e.g. /content/view/full/2, "full", and "2" being regular ordered parameters. See your module definition for more info.).
  79. * All additional named parameters will be passed as unordered params in the form "/(<paramName>)/<paramValue".
  80. *
  81. * Example :
  82. * <code>
  83. * $params = array(
  84. * 'module_uri' => '/content/view/full/2',
  85. * 'offset' => 30,
  86. * 'limit' => 10
  87. * );
  88. * $url = $legacyRouter->generate( 'ez_legacy', $params );
  89. * // $url will be "/content/view/full/2/(offset)/30/(limit)/10"
  90. * </code>
  91. *
  92. * @param string $name The name of the route
  93. * @param mixed $parameters An array of parameters
  94. * @param int $referenceType The type of reference to be generated (one of the constants)
  95. *
  96. * @throws \Symfony\Component\Routing\Exception\RouteNotFoundException
  97. * @throws \InvalidArgumentException
  98. *
  99. * @return string The generated URL
  100. *
  101. * @api
  102. */
  103. public function generate($name, $parameters = [], $referenceType = self::ABSOLUTE_PATH)
  104. {
  105. if ($name === self::ROUTE_NAME) {
  106. if (!isset($parameters['module_uri'])) {
  107. throw new \InvalidArgumentException('When generating an eZ Publish legacy fallback route, "uri" parameter must be provided.');
  108. }
  110. $moduleUri = $parameters['module_uri'];
  111. unset($parameters['module_uri']);
  113. return $this->urlGenerator->generate($moduleUri, $parameters, $referenceType);
  114. }
  116. throw new RouteNotFoundException();
  117. }
  119. public function match($pathinfo)
  120. {
  121. throw new RuntimeException("The UrlAliasRouter doesn't support the match() method. Please use matchRequest() instead.");
  122. }
  124. public function matchRequest(Request $request)
  125. {
  126. $moduleUri = rtrim($request->attributes->get('semanticPathinfo', $request->getPathInfo()), '/')
  127. . $request->attributes->get('viewParametersString', '')
  128. . '?' . $request->getQueryString();
  130. return [
  131. '_route' => self::ROUTE_NAME,
  132. '_controller' => 'ezpublish_legacy.controller:indexAction',
  133. 'module_uri' => $moduleUri,
  134. ];
  135. }
  136. }