Support custom route keys with Route::localizedUrl()

Author: ivanvermeyen

src/LocalizedUrlGenerator.php

@@ -370,7 +370,7 @@ protected function prepareParameters($locale, $parameters)
 
         foreach ($parameters as $key => $parameter) {
             if ($parameter instanceof UrlRoutable) {
-                $parameters[$key] = $this->getLocalizedRouteKey($parameter, $locale);
+                $parameters[$key] = $this->getLocalizedRouteKey($key, $parameter, $locale);
             }
         }
 
@@ -390,24 +390,47 @@ protected function getRouteParameters()
     /**
      * Get the localized route key from a model.
      *
+     * @param string $key
      * @param \Illuminate\Contracts\Routing\UrlRoutable $model
      * @param string $locale
      *
      * @return string
      */
-    protected function getLocalizedRouteKey(UrlRoutable $model, $locale)
+    protected function getLocalizedRouteKey($key, UrlRoutable $model, $locale)
     {
         $originalLocale = App::getLocale();
 
         App::setLocale($locale);
 
-        $routeKey = $model->getRouteKey();
+        $bindingField = $this->getBindingFieldFor($key, $model);
+        $routeKey = $model->$bindingField;
 
         App::setLocale($originalLocale);
 
         return $routeKey;
     }
 
+    /**
+     * Get the binding field for the current route.
+     *
+     * The binding field is the custom route key that you can define in your route:
+     * Route::get('path/{model:key}')
+     * If you did not use a custom key, use the default route key.
+     *
+     * @param string|int $key
+     * @param \Illuminate\Contracts\Routing\UrlRoutable $model
+     *
+     * @return string|null
+     */
+    protected function getBindingFieldFor($key, UrlRoutable $model)
+    {
+        if (App::version() < 7) {
+            return $model->getRouteKeyName();
+        }
+
+        return $this->route->bindingFieldFor($key) ?: $model->getRouteKeyName();
+    }
+
     /**
      * Get the locale that should be omitted in the URI path.
      *

tests/Unit/Macros/LocalizedUrlMacroTest.php

@@ -16,7 +16,7 @@
 class LocalizedUrlMacroTest extends TestCase
 {
     /** @test */
-    public function it_generates_urls_with_localized_route_keys_for_the_current_route_using_route_model_binding()
+    public function it_generates_urls_with_default_localized_route_keys_for_the_current_route_using_route_model_binding()
     {
         $this->withoutExceptionHandling();
         $this->setSupportedLocales(['en', 'nl']);
@@ -49,6 +49,40 @@ public function it_generates_urls_with_localized_route_keys_for_the_current_rout
         ], $response->original);
     }
 
+    /** @test */
+    public function it_generates_urls_with_custom_localized_route_keys_for_the_current_route_using_route_model_binding()
+    {
+        $this->withoutExceptionHandling();
+        $this->setSupportedLocales(['en', 'nl']);
+
+        $model = (new Model([
+            'slug' => [
+                'en' => 'en-slug',
+                'nl' => 'nl-slug',
+            ],
+        ]))->setKeyName('id');
+
+        App::instance(Model::class, $model);
+
+        Route::localized(function () {
+            Route::get('route/{model:slug}', function (Model $model) {
+                return [
+                    'current' => Route::localizedUrl(),
+                    'en' => Route::localizedUrl('en'),
+                    'nl' => Route::localizedUrl('nl'),
+                ];
+            })->middleware(['web']);
+        });
+
+        $response = $this->call('GET', '/en/route/en-slug');
+        $response->assertOk();
+        $this->assertEquals([
+            'current' => url('/en/route/en-slug'),
+            'en' => url('/en/route/en-slug'),
+            'nl' => url('/nl/route/nl-slug'),
+        ], $response->original);
+    }
+
     /** @test */
     public function you_can_implement_an_interface_and_let_your_model_return_custom_parameters_with_route_model_binding()
     {