Accept query string parameters via Route::localizedUrl()

Author: ivanvermeyen

src/LocalizedUrlGenerator.php

@@ -48,16 +48,29 @@ public function generateFromRequest($locale = null, $parameters = null, $absolut
     {
         $urlBuilder = UrlBuilder::make(Request::fullUrl());
         $locale = $locale ?: $this->detectLocale($urlBuilder);
-        $parameters = $this->prepareParameters($locale, $parameters ?: $this->getRouteParameters());
 
-        if ($url = $this->generateFromNamedRoute($locale, $parameters, $absolute)) {
-            return $url . $urlBuilder->getQueryString();
-        }
+        // $parameters can be an array, a function or it can contain model instances!
+        // Normalize the parameters so we end up with an array of key => value pairs.
+        $parameters = $this->prepareParameters($locale, $parameters ?: $this->getRouteParameters());
 
         if ( ! $this->is404()) {
-            $urlBuilder->setPath($this->replaceParameters($this->route->uri(), $parameters));
+            $urlBuilder->setPath($this->route->uri());
+
+            list($slugs, $query) = $this->extractQueryParameters($urlBuilder->getPath(), $parameters);
+
+            if (count($query)) {
+                $urlBuilder->setQuery($query);
+            }
+
+            if ($url = $this->generateFromNamedRoute($locale, $parameters, $absolute)) {
+                return empty($query) ? $url . $urlBuilder->getQueryString() : $url;
+            }
+
+            $urlBuilder->setPath($this->replaceParameters($this->route->uri(), $slugs));
         }
 
+        // If custom domains are not used and it is not a registered,
+        // non localized route, update the locale slug in the path.
         if ( ! $this->hasCustomDomains() && ($this->is404() || $this->isLocalized())) {
             $urlBuilder->setSlugs($this->updateLocaleInSlugs($urlBuilder->getSlugs(), $locale));
         }
@@ -284,21 +297,54 @@ protected function updateLocaleInSlugs(array $slugs, $locale)
     }
 
     /**
-     * Replace parameter placeholders with their value.
+     * Extract URI parameters and query string parameters.
      *
      * @param string $uri
      * @param array $parameters
      *
-     * @return string
+     * @return array
      */
-    protected function replaceParameters($uri, $parameters)
+    protected function extractQueryParameters($uri, $parameters)
     {
         preg_match_all('/{([a-z_.-]+)}/', $uri, $matches);
         $paramKeys = $matches[1] ?? [];
 
-        foreach ($paramKeys as $index => $key) {
-            $value = $parameters[$key] ?? $parameters[$index];
-            $uri = str_replace("{{$key}}", $value, $uri);
+        $slugs = [];
+        $query = [];
+        $i = 0;
+
+        foreach ($parameters as $key => $value) {
+            // Parameters should be in the same order as the placeholders.
+            // $key can be a name or an index, so grab the matching key name from the URI.
+            $paramKey = $paramKeys[$i] ?? null;
+
+            // If there is a matching $paramKey,
+            // we are dealing with a normal parameter,
+            // else we are dealing with a query string parameter.
+            if ($paramKey) {
+                $slugs["{{$paramKey}}"] = $value;
+            } else {
+                $query[$key] = $value;
+            }
+
+            $i++;
+        }
+
+        return [$slugs, $query];
+    }
+
+    /**
+     * Replace parameter placeholders with their value.
+     *
+     * @param string $uri
+     * @param array $parameters
+     *
+     * @return string
+     */
+    protected function replaceParameters($uri, $parameters)
+    {
+        foreach ($parameters as $placeholder => $value) {
+            $uri = str_replace($placeholder, $value, $uri);
         }
 
         return $uri;

src/UrlBuilder.php

@@ -131,6 +131,20 @@ public function getQueryString()
         return $this->get('query') ? '?' . $this->get('query') : '';
     }
 
+    /**
+     * Set the query string parameters.
+     *
+     * @param array $query
+     *
+     * @return \CodeZero\LocalizedRoutes\UrlBuilder
+     */
+    public function setQuery(array $query)
+    {
+        $this->set('query', http_build_query($query));
+
+        return $this;
+    }
+
     /**
      * Get the value of a URL part.
      *

tests/Unit/Macros/LocalizedUrlMacroTest.php

@@ -679,6 +679,52 @@ public function it_returns_a_url_with_query_string_for_existing_localized_named_
         ], $response->original);
     }
 
+    /** @test */
+    public function it_accepts_query_string_parameters_using_named_routes()
+    {
+        $this->withoutExceptionHandling();
+        $this->setSupportedLocales(['en', 'nl']);
+
+        Route::get('route/{slug}', function () {
+            return [
+                'current' => Route::localizedUrl(null, ['another-slug', 'new' => 'value']),
+                'en' => Route::localizedUrl('en', ['another-slug', 'new' => 'value']),
+                'nl' => Route::localizedUrl('nl', ['another-slug', 'new' => 'value']),
+            ];
+        })->name('route');
+
+        $response = $this->call('GET', '/route/some-slug?param=value');
+        $response->assertOk();
+        $this->assertEquals([
+            'current' => url('/route/another-slug?new=value'),
+            'en' => url('/route/another-slug?new=value'),
+            'nl' => url('/route/another-slug?new=value'),
+        ], $response->original);
+    }
+
+    /** @test */
+    public function it_accepts_query_string_parameters_using_unnamed_routes()
+    {
+        $this->withoutExceptionHandling();
+        $this->setSupportedLocales(['en', 'nl']);
+
+        Route::get('route/{slug}', function () {
+            return [
+                'current' => Route::localizedUrl(null, ['another-slug', 'new' => 'value']),
+                'en' => Route::localizedUrl('en', ['another-slug', 'new' => 'value']),
+                'nl' => Route::localizedUrl('nl', ['another-slug', 'new' => 'value']),
+            ];
+        });
+
+        $response = $this->call('GET', '/route/some-slug?param=value');
+        $response->assertOk();
+        $this->assertEquals([
+            'current' => url('/route/another-slug?new=value'),
+            'en' => url('/route/another-slug?new=value'),
+            'nl' => url('/route/another-slug?new=value'),
+        ], $response->original);
+    }
+
     /** @test */
     public function it_returns_a_url_with_translated_slugs_for_named_routes()
     {