Merge pull request #18 from Laravel-Backpack/add-option-to-dont-setup-routes

ability to customize package routes

Author: pxpm

config/language-switcher.php

@@ -0,0 +1,11 @@
+<?php
+
+return [
+    // when `false` developer should setup their own route for language switcher
+    // check the default route at /vendor/backpack/language-switcher/routes/language-switcher.php
+    'setup_routes' => true,
+
+    // when true, we will add the route prefix on the language-switcher route.
+    // eg: https://domain.com/admin/set-locale/{locale} instead of https://domain.com/set-locale/{locale}
+    'use_backpack_route_prefix' => false,
+];

readme.md

@@ -21,6 +21,9 @@ Try it right now, in [our online demo](https://demo.backpackforlaravel.com/admin
 
 ```bash
 composer require backpack/language-switcher
+
+# optional: publish the config file
+php artisan vendor:publish --provider="Backpack\LanguageSwitcher\LanguageSwitcherServiceProvider" --tag="config"
 ```
 
 2) Add the middleware to backpack config `config/backpack/base.php`:
@@ -77,6 +80,12 @@ protected $middlewareGroups = [
     ],
 ```
 
+### Can I customize the endpoint routes ? 
+**Yes!**
+You can do it by publishing the config file `php artisan vendor:publish --provider="Backpack\LanguageSwitcher\LanguageSwitcherServiceProvider" --tag="config"`.
+There you can totally disable the package route and register your own, or change some behavior related with display urls.
+
+Please take caution to protect the endpoint with throttling or any other security measure if you overwrite the routes. The default package route uses: `'throttle:60,1'`
 
 ## Notes
 

resources/views/language-switcher.blade.php

@@ -14,9 +14,16 @@
         @endif
     </a>
     <ul class="dropdown-menu dropdown-menu-right dropdown-menu-end" style="right: 0">
+        @php
+            $useAdminPrefix = config('backpack.language-switcher.use_backpack_route_prefix');
+        @endphp
         @foreach(config('backpack.crud.locales', []) as $locale => $name)
         <li>
-            <a class="dropdown-item {{ $locale === $helper->getCurrentLocale() ? 'active disabled' : '' }}" href="{{ route('language-switcher.locale', $locale) }}">
+            <a class="dropdown-item {{ $locale === $helper->getCurrentLocale() ? 'active disabled' : '' }}" href="{{ route('language-switcher.locale', [
+                    'locale' => $useAdminPrefix ? $locale : null, 
+                    'backpack_prefix' => $useAdminPrefix ? config('backpack.base.route_prefix') : 'set-locale',
+                    'setLocale' => $useAdminPrefix ? 'set-locale' : $locale
+                ])}}">
                 @if($flags ?? true)
                 <span class="nav-link-icon" style="width: fit-content">
                     <x-dynamic-component component="flag-{{ $helper->getFlagOrFallback($locale) }}" style="width: 1.5rem" />

routes/language-switcher.php

@@ -1,7 +1,5 @@
 <?php
-
-use Backpack\LanguageSwitcher\Http\Controllers\LanguageSwitcherController;
-
+use Illuminate\Support\Facades\Route;
 /*
 |--------------------------------------------------------------------------
 | Backpack\LanguageSwitcher Routes
@@ -11,11 +9,15 @@
 | handled by the Backpack\LanguageSwitcher package.
 |
 */
-Route::group([
-    'namespace' => 'Backpack\LanguageSwitcher\Http\Controllers',
-    'middleware' => ['web', 'throttle:60,1'],
-], function () {
-    // set locale
-    Route::any('set-locale/{locale}', [LanguageSwitcherController::class, 'setLocale'])
-        ->name('language-switcher.locale');
-});
+if(config('backpack.language-switcher.setup_routes', true)) {
+    Route::group([
+        'middleware' => ['web', 'throttle:60,1'],
+    ], function () {
+        // set locale
+        Route::any('{backpack_prefix?}/{setLocale}/{locale?}', [\Backpack\LanguageSwitcher\Http\Controllers\LanguageSwitcherController::class, 'setLocale'])
+            ->name('language-switcher.locale')
+            ->whereIn('setLocale', array_merge(['set-locale'],array_keys(config('backpack.crud.locales'))))
+            ->whereIn('backpack_prefix', ['set-locale', config('backpack.base.route_prefix')]);
+    });
+}
+

src/Http/Controllers/LanguageSwitcherController.php

@@ -16,12 +16,14 @@ class LanguageSwitcherController extends Controller
     /**
      * Set's the app locale
      */
-    public function setLocale(string $locale): Redirector | RedirectResponse
+    public function setLocale(?string $backpackPrefix = null, ?string $setLocale = null, ?string $locale = null): Redirector | RedirectResponse
     {
+        $locale ??= $setLocale;
+
         if (in_array($locale, array_keys(config('backpack.crud.locales')))) {
             Session::put('backpack.language-switcher.locale', $locale);
         }
 
-        return redirect(url()->previous());
+        return redirect()->back();
     }
 }