[FrameworkBundle] keep query params in redirection

Amrouche Hamza · Amrouche Hamza · commit b6a2af32c070 · 2018-02-23T14:47:20.000+01:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/Controller/RedirectController.php b/src/Symfony/Bundle/FrameworkBundle/Controller/RedirectController.php
@@ -54,15 +54,16 @@ public function __construct(UrlGeneratorInterface $router = null, int $httpPort
      *
      * @throws HttpException In case the route name is empty
      */
-    public function redirectAction(Request $request, string $route, bool $permanent = false, $ignoreAttributes = false, bool $keepRequestMethod = false): Response
+    public function redirectAction(Request $request, string $route, bool $permanent = false, $ignoreAttributes = false, bool $keepRequestMethod = false, bool $keepQueryParams = false): Response
     {
         if ('' == $route) {
             throw new HttpException($permanent ? 410 : 404);
         }
 
         $attributes = array();
         if (false === $ignoreAttributes || is_array($ignoreAttributes)) {
-            $attributes = $request->attributes->get('_route_params');
+            $routeParams = $request->attributes->get('_route_params');
+            $attributes = $keepQueryParams ? \array_merge($request->query->all(), $routeParams) : $routeParams;
             unset($attributes['route'], $attributes['permanent'], $attributes['ignoreAttributes'], $attributes['keepRequestMethod']);
             if ($ignoreAttributes) {
                 $attributes = array_diff_key($attributes, array_flip($ignoreAttributes));
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Controller/RedirectControllerTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Controller/RedirectControllerTest.php
@@ -235,6 +235,25 @@ public function testPathQueryParams($expectedUrl, $path, $queryString)
         $this->assertRedirectUrl($returnValue, $expectedUrl);
     }
 
+    public function testRedirectWithQuery()
+    {
+        $scheme = 'http';
+        $host = 'www.example.com';
+        $baseUrl = '/base';
+        $port = 80;
+
+        $request = $this->createRequestObject($scheme, $host, $port, $baseUrl, 'base=zaza');
+        $request->query = new ParameterBag(array('base' => 'zaza'));
+        $request->attributes = new ParameterBag(array('_route_params' => array()));
+        $urlGenerator = $this->getMockBuilder(UrlGeneratorInterface::class)->getMock();
+        $urlGenerator->expects($this->any())->method('generate')->will($this->returnValue('/test?base=zaza'));
+
+        $controller = new RedirectController($urlGenerator);
+
+        $returnValue = $controller->redirectAction($request, '/test', false, false, false, true);
+        $this->assertRedirectUrl($returnValue, '/test?base=zaza');
+    }
+
     private function createRequestObject($scheme, $host, $port, $baseUrl, $queryString = '')
     {
         $request = $this->getMockBuilder('Symfony\Component\HttpFoundation\Request')->getMock();

Original file line number	Diff line number	Diff line change
`@@ -54,15 +54,16 @@ public function __construct(UrlGeneratorInterface $router = null, int $httpPort`
`54`	`54`	`*`
`55`	`55`	`* @throws HttpException In case the route name is empty`
`56`	`56`	`*/`
`57`		`- public function redirectAction(Request $request, string $route, bool $permanent = false, $ignoreAttributes = false, bool $keepRequestMethod = false): Response`
	`57`	`+ public function redirectAction(Request $request, string $route, bool $permanent = false, $ignoreAttributes = false, bool $keepRequestMethod = false, bool $keepQueryParams = false): Response`
`58`	`58`	`{`
`59`	`59`	`if ('' == $route) {`
`60`	`60`	`throw new HttpException($permanent ? 410 : 404);`
`61`	`61`	`}`
`62`	`62`
`63`	`63`	`$attributes = array();`
`64`	`64`	`if (false === $ignoreAttributes \|\| is_array($ignoreAttributes)) {`
`65`		`- $attributes = $request->attributes->get('_route_params');`
	`65`	`+ $routeParams = $request->attributes->get('_route_params');`
	`66`	`+ $attributes = $keepQueryParams ? \array_merge($request->query->all(), $routeParams) : $routeParams;`
`66`	`67`	`unset($attributes['route'], $attributes['permanent'], $attributes['ignoreAttributes'], $attributes['keepRequestMethod']);`
`67`	`68`	`if ($ignoreAttributes) {`
`68`	`69`	`$attributes = array_diff_key($attributes, array_flip($ignoreAttributes));`