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

Open in your IDE?
  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. 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. const CONTENT_KEY = 'contentDocument';
  41. /**
  42. * key for the request attribute that contains the template this document
  43. * wants to use.
  44. */
  45. const CONTENT_TEMPLATE = 'template';
  47. /**
  48. * @var RequestStack
  49. */
  50. private $requestStack;
  52. /**
  53. * Put content and template name into the request attributes instead of the
  54. * route defaults.
  55. *
  56. * {@inheritdoc}
  57. *
  58. * The match should identify a controller for symfony. This can either be
  59. * the fully qualified class name or the service name of a controller that
  60. * is registered as a service. In both cases, the action to call on that
  61. * controller is appended, separated with two colons.
  62. */
  63. public function match($url)
  64. {
  65. $defaults = parent::match($url);
  67. return $this->cleanDefaults($defaults);
  68. }
  70. public function matchRequest(Request $request)
  71. {
  72. $defaults = parent::matchRequest($request);
  74. return $this->cleanDefaults($defaults, $request);
  75. }
  77. /**
  78. * Clean up the match data and move some values into the request attributes.
  79. *
  80. * @param array $defaults The defaults from the match
  81. * @param Request $request The request object if available
  82. *
  83. * @return array the updated defaults to return for this match
  84. */
  85. protected function cleanDefaults($defaults, Request $request = null)
  86. {
  87. if (null === $request) {
  88. $request = $this->getRequest();
  89. }
  91. if (\array_key_exists(RouteObjectInterface::ROUTE_OBJECT, $defaults)) {
  92. $request->attributes->set(self::ROUTE_KEY, $defaults[RouteObjectInterface::ROUTE_OBJECT]);
  93. unset($defaults[RouteObjectInterface::ROUTE_OBJECT]);
  94. }
  96. if (\array_key_exists(RouteObjectInterface::CONTENT_OBJECT, $defaults)) {
  97. $request->attributes->set(self::CONTENT_KEY, $defaults[RouteObjectInterface::CONTENT_OBJECT]);
  98. unset($defaults[RouteObjectInterface::CONTENT_OBJECT]);
  99. }
  101. if (\array_key_exists(RouteObjectInterface::TEMPLATE_NAME, $defaults)) {
  102. $request->attributes->set(self::CONTENT_TEMPLATE, $defaults[RouteObjectInterface::TEMPLATE_NAME]);
  104. // contentTemplate is deprecated as of version 2.0, to be removed in 3.0
  105. $request->attributes->set('contentTemplate', $defaults[RouteObjectInterface::TEMPLATE_NAME]);
  107. unset($defaults[RouteObjectInterface::TEMPLATE_NAME]);
  108. }
  110. return $defaults;
  111. }
  113. /**
  114. * Set the request stack so that we can find the current request.
  115. */
  116. public function setRequestStack(RequestStack $requestStack)
  117. {
  118. $this->requestStack = $requestStack;
  119. }
  121. /**
  122. * Get the current request from the request stack.
  123. *
  124. * @return Request
  125. *
  126. * @throws \Symfony\Component\Routing\Exception\ResourceNotFoundException
  127. */
  128. public function getRequest()
  129. {
  130. $currentRequest = $this->requestStack->getCurrentRequest();
  131. if (!$currentRequest) {
  132. throw new ResourceNotFoundException('There is no request in the request stack');
  133. }
  135. return $currentRequest;
  136. }
  137. }