Merge pull request #60 from AbdullahFaqeir/v2

Localised Redirections #49
chinleung · Oct 22, 2021 · 2d8e149 · 2d8e149
2 parents 843382f + 2c821bc
commit 2d8e149
Show file tree

Hide file tree

Showing 11 changed files with 255 additions and 65 deletions.
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -9,7 +9,7 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        php: ['7.2', '7.3', '7.4', '8.0']
+        php: ['7.4', '8.0']
         stability: [prefer-lowest, prefer-stable]
 
     steps:

diff --git a/README.md b/README.md
@@ -188,6 +188,13 @@ Route::multilingual('test')->data(['name' => 'Taylor']);
 Route::multilingual('test')->view('welcome', ['name' => 'Taylor']);
 ```
 
+### Redirect localized route
+
+```php
+Route::multilingual('support');
+Route::multilingual('contact')->redirect('support');
+```
+
 ## Upgrading from 1.x to 2.x
 
 To update from 1.x to 2.x, you simply have to rename the namespace occurrences in your application from `LaravelMultilingualRoutes` to `MultilingualRoutes`. The most common use case would be the `DetectRequestLocale` middleware.

diff --git a/composer.json b/composer.json
@@ -19,7 +19,7 @@
         }
     ],
     "require": {
-        "php": "^7.2|^8.0",
+        "php": "^7.4|^8.0",
         "chinleung/laravel-locales": "^1.2",
         "illuminate/support": "~5.8.0|^6.0|^7.0|^8.0"
     },

diff --git a/src/Controllers/ViewController.php b/src/Controllers/ViewController.php
@@ -15,7 +15,7 @@ class ViewController
      * @param  array  $headers
      * @return \Illuminate\Http\Response
      */
-    public function __invoke(string $view, array $data = [], int $status = 200, array $headers = [])
+    public function __invoke(string $view, array $data = [], int $status = 200, array $headers = []): \Illuminate\Http\Response
     {
         return Response::view($view, $data, $status, $headers);
     }

diff --git a/src/DetectRequestLocale.php b/src/DetectRequestLocale.php
@@ -3,6 +3,7 @@
 namespace ChinLeung\MultilingualRoutes;
 
 use Closure;
+use Symfony\Component\HttpFoundation\Request;
 
 class DetectRequestLocale
 {
@@ -13,11 +14,11 @@ class DetectRequestLocale
      * @param  \Closure  $next
      * @return mixed
      */
-    public function handle($request, Closure $next)
+    public function handle(Request $request, Closure $next)
     {
         $segment = $request->locale ?: $request->segment(1);
 
-        if (in_array($segment, locales())) {
+        if (in_array($segment, locales(), false)) {
             app()->setLocale($segment);
         }
 

diff --git a/src/Macros/RequestMacros.php b/src/Macros/RequestMacros.php
@@ -16,9 +16,7 @@ class RequestMacros
     public function localizedRouteIs(): Closure
     {
         return function (...$patterns) {
-            return $this->routeIs(array_map(function ($pattern) {
-                return locale().".{$pattern}";
-            }, $patterns));
+            return $this->routeIs(array_map(static fn ($pattern) => locale().".{$pattern}", $patterns));
         };
     }
 }
diff --git a/src/Macros/RouterMacros.php b/src/Macros/RouterMacros.php
@@ -23,7 +23,7 @@ public function multilingual(): Closure
                 $this->container && $this->container->bound(MultilingualRegistrar::class)
                     ? $this->container->make(MultilingualRegistrar::class)
                     : new MultilingualRegistrar($this),
-                $key == '/' ? $key : ltrim($key, '/'),
+                $key === '/' ? $key : ltrim($key, '/'),
                 $handle,
                 $locales ?: locales()
             );

diff --git a/src/MultilingualRegistrar.php b/src/MultilingualRegistrar.php
@@ -15,7 +15,7 @@ class MultilingualRegistrar
      *
      * @var \Illuminate\Routing\Router
      */
-    protected $router;
+    protected Router $router;
 
     /**
      * Constructor of the class.
@@ -52,40 +52,90 @@ public function register(string $key, $handle, array $locales, array $options):
     }
 
     /**
-     * Register a single route.
+     * Register the redirect routes.
      *
      * @param  string  $key
-     * @param  mixed  $handle
+     * @param  string  $destination
+     * @param  int  $status
+     * @param  array  $locales
+     * @param  array  $options
+     * @return \Illuminate\Routing\RouteCollection
+     */
+    public function redirect(string $key, string $destination, int $status, array $locales, array $options): RouteCollection
+    {
+        foreach ($locales as $locale) {
+            $route = $this->registerRedirectRoute($key, $destination, $status, $locale, $options);
+
+            if (isset($options['defaults']) && is_array($options['defaults'])) {
+                foreach ($options['defaults'] as $paramKey => $paramValue) {
+                    $route->defaults($paramKey, $paramValue);
+                }
+            }
+        }
+
+        return tap($this->router->getRoutes())->refreshNameLookups();
+    }
+
+    /**
+     * Register a single redirect route.
+     *
+     * @param  string  $key
+     * @param  string  $destination
+     * @param  int  $status
      * @param  string  $locale
      * @param  array  $options
      * @return \Illuminate\Routing\Route
      */
-    protected function registerRoute(string $key, $handle, string $locale, array $options): Route
+    protected function registerRedirectRoute(string $key, string $destination, int $status, string $locale, array $options): Route
     {
-        $route = $this->generateRoute($key, $handle, $locale, $options);
+        $route = $this->generateRedirectRoute($key, $destination, $status, $locale, $options);
 
-        $this->applyConstraints($route, $locale, $options);
+        return $this->finalizeRoute($route, $key, $locale, $options);
+    }
 
-        if ($prefix = $this->generatePrefixForLocale($key, $locale)) {
-            $route->setUri("{$prefix}/{$route->uri}");
-        }
+    /**
+     * Generate a redirect route.
+     *
+     * @param  string  $key
+     * @param  string  $destination
+     * @param  int  $status
+     * @param  string  $locale
+     * @param  array  $options
+     * @return \Illuminate\Routing\Route
+     */
+    protected function generateRedirectRoute(string $key, string $destination, int $status, string $locale, array $options): Route
+    {
+        $route = $this->router->any(
+            $this->applyUniqueRegistrationKey(
+                $this->generateUriFromKey($key, $locale),
+                $locale
+            ),
+            '\Illuminate\Routing\RedirectController'
+        );
 
-        if ($middleware = Arr::get($options, 'middleware')) {
-            $route->middleware($middleware);
-        }
+        $route->defaults('destination', $this->cleanUri($this->applyUniqueRegistrationKey(
+            $this->generateUriFromKey($destination, $locale),
+            $locale
+        ), $locale));
+        $route->defaults('status', $status);
 
-        data_set($route, 'action.as', (
-            $this->generateNameForLocaleFromOptions(
-                $locale,
-                $key,
-                array_merge(
-                    ['as' => data_get($route, 'action.as')],
-                    $options
-                )
-            )
-        ));
+        return $route;
+    }
 
-        return $this->cleanUniqueRegistrationKey($route, $locale);
+    /**
+     * Register a single route.
+     *
+     * @param  string  $key
+     * @param  mixed  $handle
+     * @param  string  $locale
+     * @param  array  $options
+     * @return \Illuminate\Routing\Route
+     */
+    protected function registerRoute(string $key, $handle, string $locale, array $options): Route
+    {
+        $route = $this->generateRoute($key, $handle, $locale, $options);
+
+        return $this->finalizeRoute($route, $key, $locale, $options);
     }
 
     /**
@@ -119,6 +169,41 @@ protected function generateRoute(string $key, $handle, string $locale, array $op
         return $route;
     }
 
+    /**
+     * Finalize route registration.
+     *
+     * @param  \Illuminate\Routing\Route  $route
+     * @param  string  $key
+     * @param  string  $locale
+     * @param  array  $options
+     * @return \Illuminate\Routing\Route
+     */
+    protected function finalizeRoute(Route $route, string $key, string $locale, array $options): Route
+    {
+        $this->applyConstraints($route, $locale, $options);
+
+        if ($prefix = $this->generatePrefixForLocale($key, $locale)) {
+            $route->setUri("{$prefix}/{$route->uri}");
+        }
+
+        if ($middleware = Arr::get($options, 'middleware')) {
+            $route->middleware($middleware);
+        }
+
+        data_set($route, 'action.as', (
+        $this->generateNameForLocaleFromOptions(
+            $locale,
+            $key,
+            array_merge(
+                ['as' => data_get($route, 'action.as')],
+                $options
+            )
+        )
+        ));
+
+        return $this->cleanUniqueRegistrationKey($route, $locale);
+    }
+
     /**
      * Retrieve the request method from the options.
      *
@@ -129,7 +214,7 @@ protected function getRequestMethodFromOptions(array $options): array
     {
         $method = $options['method'] ?? 'get';
 
-        if ($method == 'get') {
+        if ($method === 'get') {
             return ['GET', 'HEAD'];
         }
 
@@ -150,8 +235,8 @@ protected function generateNameForLocaleFromOptions(string $locale, string $key,
 
         if ($prefix = Arr::get($options, 'as')) {
             return config('laravel-multilingual-routes.name_prefix_before_locale')
-                ? "{$prefix}{$locale}.{$name}"
-                : "{$locale}.{$prefix}{$name}";
+                ? "{$prefix}{$locale}.$name"
+                : "$locale.{$prefix}{$name}";
         }
 
         return "{$locale}.{$name}";
@@ -166,7 +251,7 @@ protected function generateNameForLocaleFromOptions(string $locale, string $key,
      */
     protected function generatePrefixForLocale(string $key, string $locale): ?string
     {
-        if ($key == '/' || $this->shouldNotPrefixLocale($locale)) {
+        if ($key === '/' || $this->shouldNotPrefixLocale($locale)) {
             return null;
         }
 
@@ -182,12 +267,12 @@ protected function generatePrefixForLocale(string $key, string $locale): ?string
      */
     protected function generateUriFromKey(string $key, string $locale): string
     {
-        if ($key == '/') {
-            return $this->shouldNotPrefixHome($locale) ? '/' : "/{$locale}";
+        if ($key === '/') {
+            return $this->shouldNotPrefixHome($locale) ? '/' : "/$locale";
         }
 
-        return Lang::has("routes.{$key}", $locale)
-            ? trans("routes.{$key}", [], $locale)
+        return Lang::has("routes.$key", $locale)
+            ? trans("routes.$key", [], $locale)
             : $key;
     }
 
@@ -213,7 +298,31 @@ protected function applyUniqueRegistrationKey(string $uri, string $locale): stri
      */
     protected function cleanUniqueRegistrationKey(Route $route, string $locale): Route
     {
-        return $route->setUri(rtrim(str_replace("__{$locale}__", '', $route->uri), '/'));
+        return $route->setUri($this->cleanRoute($route, $locale));
+    }
+
+    /**
+     * Clean route uri from locale.
+     *
+     * @param  \Illuminate\Routing\Route  $route
+     * @param  string  $locale
+     * @return string
+     */
+    protected function cleanRoute(Route $route, string $locale): string
+    {
+        return $this->cleanUri($route->uri, $locale);
+    }
+
+    /**
+     * Clean uri from locale.
+     *
+     * @param  string  $uri
+     * @param  string  $locale
+     * @return string
+     */
+    protected function cleanUri(string $uri, string $locale): string
+    {
+        return rtrim(str_replace("__{$locale}__", '', $uri), '/');
     }
 
     /**
@@ -224,7 +333,7 @@ protected function cleanUniqueRegistrationKey(Route $route, string $locale): Rou
      */
     protected function shouldNotPrefixLocale(string $locale): bool
     {
-        return $locale == config('laravel-multilingual-routes.default')
+        return $locale === config('laravel-multilingual-routes.default')
             && ! config('laravel-multilingual-routes.prefix_default');
     }
 
@@ -248,7 +357,7 @@ protected function shouldNotPrefixHome(string $locale): bool
      */
     protected function shouldNotPrefixDefaultHome(string $locale): bool
     {
-        return $locale == config('laravel-multilingual-routes.default')
+        return $locale === config('laravel-multilingual-routes.default')
             && ! config('laravel-multilingual-routes.prefix_default_home');
     }
 
@@ -260,11 +369,11 @@ protected function shouldNotPrefixDefaultHome(string $locale): bool
      * @param  array  $options
      * @return void
      */
-    protected function applyConstraints(Route $route, string $locale, $options): void
+    protected function applyConstraints(Route $route, string $locale, array $options): void
     {
         $constraints = array_merge(
             Arr::get($options, 'constraints', []),
-            Arr::get($options, "constraints-{$locale}", [])
+            Arr::get($options, "constraints-$locale", [])
         );
 
         foreach ($constraints as $name => $expression) {