Allow model to provide custom route parameters

Author: ivanvermeyen

src/Macros/LocalizedUrlMacro.php

@@ -2,6 +2,8 @@
 
 namespace CodeZero\LocalizedRoutes\Macros;
 
+use CodeZero\LocalizedRoutes\ProvidesRouteParameters;
+use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\Route;
 
 class LocalizedUrlMacro
@@ -14,7 +16,16 @@ class LocalizedUrlMacro
     public static function register()
     {
         Route::macro('localizedUrl', function ($locale = null, $parameters = null, $absolute = true) {
-            return route(Route::currentRouteName(), $parameters ?: Route::current()->parameters(), $absolute, $locale);
+            if ( ! $parameters) {
+                $parameters = Route::current()->parameters();
+                $model = Collection::make($parameters)->first();
+
+                if ($model instanceof ProvidesRouteParameters) {
+                    $parameters = $model->getRouteParameters($locale);
+                }
+            }
+
+            return route(Route::currentRouteName(), $parameters, $absolute, $locale);
         });
     }
 }

src/ProvidesRouteParameters.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace CodeZero\LocalizedRoutes;
+
+interface ProvidesRouteParameters
+{
+    /**
+     * Get the route parameters for this model.
+     *
+     * @param string|null $locale
+     *
+     * @return array
+     */
+    public function getRouteParameters($locale = null);
+}

tests/Stubs/ModelWithCustomRouteParameters.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace CodeZero\LocalizedRoutes\Tests\Stubs;
+
+use CodeZero\LocalizedRoutes\ProvidesRouteParameters;
+use Illuminate\Database\Eloquent\Model as BaseModel;
+use Illuminate\Support\Facades\App;
+
+class ModelWithCustomRouteParameters extends BaseModel implements ProvidesRouteParameters
+{
+    protected $guarded = [];
+
+    /**
+     * Get the route parameters for this model.
+     *
+     * @param string|null $locale
+     *
+     * @return array
+     */
+    public function getRouteParameters($locale = null)
+    {
+        return [
+            $this->id,
+            $this->attributes['slug'][$locale ?: App::getLocale()]
+        ];
+    }
+
+    /**
+     * Fake route model binding (avoid database for test purpose).
+     *
+     * @param int $id
+     *
+     * @return mixed
+     */
+    public function resolveRouteBinding($id)
+    {
+        return $this;
+    }
+}

tests/Unit/Macros/CurrentUrlMacroTest.php

@@ -3,6 +3,7 @@
 namespace CodeZero\LocalizedRoutes\Tests\Unit\Macros;
 
 use CodeZero\LocalizedRoutes\Tests\Stubs\Model;
+use CodeZero\LocalizedRoutes\Tests\Stubs\ModelWithCustomRouteParameters;
 use CodeZero\LocalizedRoutes\Tests\TestCase;
 use Illuminate\Support\Facades\App;
 use Illuminate\Support\Facades\Route;
@@ -42,6 +43,40 @@ public function it_automatically_generates_urls_with_localized_route_keys_for_th
         ], $response->original);
     }
 
+    /** @test */
+    public function you_can_implement_an_interface_and_let_your_model_return_custom_parameters_with_route_model_binding()
+    {
+        $this->setSupportedLocales(['en', 'nl']);
+
+        $model = (new ModelWithCustomRouteParameters([
+            'id' => 1,
+            'slug' => [
+                'en' => 'en-slug',
+                'nl' => 'nl-slug',
+            ],
+        ]))->setKeyName('id');
+
+        App::instance(ModelWithCustomRouteParameters::class, $model);
+
+        Route::localized(function () {
+            Route::get('route/{model}/{slug}', function (ModelWithCustomRouteParameters $model, $slug) {
+                return [
+                    'current' => Route::localizedUrl(),
+                    'en' => Route::localizedUrl('en'),
+                    'nl' => Route::localizedUrl('nl'),
+                ];
+            })->middleware(['web']);
+        });
+
+        $response = $this->call('GET', '/en/route/1/en-slug');
+        $response->assertOk();
+        $this->assertEquals([
+            'current' => url('/en/route/1/en-slug'),
+            'en' => url('/en/route/1/en-slug'),
+            'nl' => url('/nl/route/1/nl-slug'),
+        ], $response->original);
+    }
+
     /** @test */
     public function it_cannot_guess_a_localized_route_key_without_route_model_binding()
     {