/**
* Initializes the context from the request and sets request attributes based on a matching route.
*
- * This listener works in 2 modes:
- *
- * * 2.3 compatibility mode where you must call setRequest whenever the Request changes.
- * * 2.4+ mode where you must pass a RequestStack instance in the constructor.
- *
* @author Fabien Potencier <fabien@symfony.com>
*/
class RouterListener implements EventSubscriberInterface
private $matcher;
private $context;
private $logger;
- private $request;
private $requestStack;
/**
* Constructor.
*
- * RequestStack will become required in 3.0.
- *
* @param UrlMatcherInterface|RequestMatcherInterface $matcher The Url or Request matcher
* @param RequestStack $requestStack A RequestStack instance
* @param RequestContext|null $context The RequestContext (can be null when $matcher implements RequestContextAwareInterface)
*
* @throws \InvalidArgumentException
*/
- public function __construct($matcher, $requestStack = null, $context = null, $logger = null)
+ public function __construct($matcher, RequestStack $requestStack, RequestContext $context = null, LoggerInterface $logger = null)
{
- if ($requestStack instanceof RequestContext || $context instanceof LoggerInterface || $logger instanceof RequestStack) {
- $tmp = $requestStack;
- $requestStack = $logger;
- $logger = $context;
- $context = $tmp;
-
- @trigger_error('The '.__METHOD__.' method now requires a RequestStack to be given as second argument as '.__CLASS__.'::setRequest method will not be supported anymore in 3.0.', E_USER_DEPRECATED);
- } elseif (!$requestStack instanceof RequestStack) {
- @trigger_error('The '.__METHOD__.' method now requires a RequestStack instance as '.__CLASS__.'::setRequest method will not be supported anymore in 3.0.', E_USER_DEPRECATED);
- }
-
- if (null !== $requestStack && !$requestStack instanceof RequestStack) {
- throw new \InvalidArgumentException('RequestStack instance expected.');
- }
- if (null !== $context && !$context instanceof RequestContext) {
- throw new \InvalidArgumentException('RequestContext instance expected.');
- }
- if (null !== $logger && !$logger instanceof LoggerInterface) {
- throw new \InvalidArgumentException('Logger must implement LoggerInterface.');
- }
-
if (!$matcher instanceof UrlMatcherInterface && !$matcher instanceof RequestMatcherInterface) {
throw new \InvalidArgumentException('Matcher must either implement UrlMatcherInterface or RequestMatcherInterface.');
}
$this->logger = $logger;
}
- /**
- * Sets the current Request.
- *
- * This method was used to synchronize the Request, but as the HttpKernel
- * is doing that automatically now, you should never call it directly.
- * It is kept public for BC with the 2.3 version.
- *
- * @param Request|null $request A Request instance
- *
- * @deprecated since version 2.4, to be removed in 3.0.
- */
- public function setRequest(Request $request = null)
- {
- @trigger_error('The '.__METHOD__.' method is deprecated since version 2.4 and will be made private in 3.0.', E_USER_DEPRECATED);
-
- $this->setCurrentRequest($request);
- }
-
private function setCurrentRequest(Request $request = null)
{
- if (null !== $request && $this->request !== $request) {
+ if (null !== $request) {
$this->context->fromRequest($request);
}
-
- $this->request = $request;
}
+ /**
+ * After a sub-request is done, we need to reset the routing context to the parent request so that the URL generator
+ * operates on the correct context again.
+ *
+ * @param FinishRequestEvent $event
+ */
public function onKernelFinishRequest(FinishRequestEvent $event)
{
- if (null === $this->requestStack) {
- return; // removed when requestStack is required
- }
-
$this->setCurrentRequest($this->requestStack->getParentRequest());
}
{
$request = $event->getRequest();
- // initialize the context that is also used by the generator (assuming matcher and generator share the same context instance)
- // we call setCurrentRequest even if most of the time, it has already been done to keep compatibility
- // with frameworks which do not use the Symfony service container
- // when we have a RequestStack, no need to do it
- if (null !== $this->requestStack) {
- $this->setCurrentRequest($request);
- }
+ $this->setCurrentRequest($request);
if ($request->attributes->has('_controller')) {
// routing is already done
}
if (null !== $this->logger) {
- $this->logger->info(sprintf('Matched route "%s".', isset($parameters['_route']) ? $parameters['_route'] : 'n/a'), array(
+ $this->logger->info('Matched route "{route}".', array(
+ 'route' => isset($parameters['_route']) ? $parameters['_route'] : 'n/a',
'route_parameters' => $parameters,
'request_uri' => $request->getUri(),
+ 'method' => $request->getMethod(),
));
}