Merge codezero/laravel-localizer (#83)

Closes #22

Author: ivanvermeyen

composer.json

@@ -22,7 +22,7 @@
     "require": {
         "php": "^7.2.5|^8.0",
         "0.0.0/composer-include-files": "^1.5",
-        "codezero/laravel-localizer": "dev-master",
+        "codezero/browser-locale": "^3.0",
         "codezero/laravel-uri-translator": "^1.0",
         "illuminate/support": "^7.0|^8.0|^9.0|^10.0"
     },

config/localized-routes.php

@@ -41,9 +41,67 @@
     '404_view' => 'errors.404',
 
     /**
-     * The custom route action where we will set the locale of
-     * the routes registered within the Route::localized() closure.
+     * The custom route action where we will set the locale of the routes
+     * that are registered within the Route::localized() closure.
+     * This can be detected by the RouteActionDetector.
      */
     'route_action' => 'locale',
 
+    /**
+     * The attribute on the user model that holds the locale,
+     * when using the UserDetector.
+     */
+    'user_attribute' => 'locale',
+
+    /**
+     * The session key that holds the locale,
+     * when using the SessionDetector and SessionStore.
+     */
+    'session_key' => 'locale',
+
+    /**
+     * The name of the cookie that holds the locale,
+     * when using the CookieDetector and CookieStore.
+     */
+    'cookie_name' => 'locale',
+
+    /**
+     * The lifetime of the cookie that holds the locale,
+     * when using the CookieStore.
+     */
+    'cookie_minutes' => 60 * 24 * 365, // 1 year
+
+    /**
+     * The detectors to use to find a matching locale.
+     * These will be executed in the order that they are added to the array!
+     */
+    'detectors' => [
+        CodeZero\LocalizedRoutes\Middleware\Detectors\RouteActionDetector::class,
+        CodeZero\LocalizedRoutes\Middleware\Detectors\UrlDetector::class,
+        CodeZero\LocalizedRoutes\Middleware\Detectors\OmittedLocaleDetector::class,
+        CodeZero\LocalizedRoutes\Middleware\Detectors\UserDetector::class,
+        CodeZero\LocalizedRoutes\Middleware\Detectors\SessionDetector::class,
+        CodeZero\LocalizedRoutes\Middleware\Detectors\CookieDetector::class,
+        CodeZero\LocalizedRoutes\Middleware\Detectors\BrowserDetector::class,
+        CodeZero\LocalizedRoutes\Middleware\Detectors\AppDetector::class,
+    ],
+
+    /**
+     * Add any of the above detector class names here to make it trusted.
+     * When a trusted detector returns a locale, it will be used
+     * as the app locale, regardless if it's a supported locale or not.
+     */
+    'trusted_detectors' => [
+        CodeZero\LocalizedRoutes\Middleware\Detectors\RouteActionDetector::class //=> required for scoped config
+    ],
+
+    /**
+     * The stores to store the first matching locale in.
+     */
+    'stores' => [
+        CodeZero\LocalizedRoutes\Middleware\Stores\SessionStore::class,
+        CodeZero\LocalizedRoutes\Middleware\Stores\CookieStore::class,
+        CodeZero\LocalizedRoutes\Middleware\Stores\AppStore::class,
+    ],
+
 ];

src/LocalizedRoutesServiceProvider.php

@@ -2,13 +2,14 @@
 
 namespace CodeZero\LocalizedRoutes;
 
+use CodeZero\BrowserLocale\Laravel\BrowserLocaleServiceProvider;
 use CodeZero\LocalizedRoutes\Illuminate\Routing\UrlGenerator;
 use CodeZero\LocalizedRoutes\Macros\Route\HasLocalizedMacro;
 use CodeZero\LocalizedRoutes\Macros\Route\isFallbackMacro;
 use CodeZero\LocalizedRoutes\Macros\Route\IsLocalizedMacro;
 use CodeZero\LocalizedRoutes\Macros\Route\LocalizedMacro;
 use CodeZero\LocalizedRoutes\Macros\Route\LocalizedUrlMacro;
-use CodeZero\Localizer\LocalizerServiceProvider;
+use CodeZero\LocalizedRoutes\Middleware\LocaleHandler;
 use CodeZero\UriTranslator\UriTranslatorServiceProvider;
 use Illuminate\Contracts\Routing\UrlGenerator as UrlGeneratorContract;
 use Illuminate\Support\ServiceProvider;
@@ -42,6 +43,7 @@ public function register()
     {
         $this->mergeConfig();
         $this->registerLocaleConfig();
+        $this->registerLocaleHandler();
         $this->registerUrlGenerator();
         $this->registerProviders();
     }
@@ -90,7 +92,7 @@ protected function mergeConfig()
      */
     protected function registerProviders()
     {
-        $this->app->register(LocalizerServiceProvider::class);
+        $this->app->register(BrowserLocaleServiceProvider::class);
         $this->app->register(UriTranslatorServiceProvider::class);
     }
 
@@ -108,6 +110,23 @@ protected function registerLocaleConfig()
         $this->app->bind('locale-config', LocaleConfig::class);
     }
 
+    /**
+     * Register LocaleHandler.
+     *
+     * @return void
+     */
+    protected function registerLocaleHandler()
+    {
+        $this->app->bind(LocaleHandler::class, function ($app) {
+            $locales = $app['locale-config']->getLocales();
+            $detectors = $app['config']->get("{$this->name}.detectors");
+            $stores = $app['config']->get("{$this->name}.stores");
+            $trustedDetectors = $app['config']->get("{$this->name}.trusted_detectors");
+
+            return new LocaleHandler($locales, $detectors, $stores, $trustedDetectors);
+        });
+    }
+
     /**
      * Register a custom URL generator that extends the one that comes with Laravel.
      * This will override a few methods that enables us to generate localized URLs.

src/Middleware/Detectors/AppDetector.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace CodeZero\LocalizedRoutes\Middleware\Detectors;
+
+use Illuminate\Support\Facades\App;
+
+class AppDetector implements Detector
+{
+    /**
+     * Detect the locale.
+     *
+     * @return string|array|null
+     */
+    public function detect()
+    {
+        return App::getLocale();
+    }
+}

src/Middleware/Detectors/BrowserDetector.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace CodeZero\LocalizedRoutes\Middleware\Detectors;
+
+use CodeZero\BrowserLocale\BrowserLocale;
+use CodeZero\BrowserLocale\Filters\CombinedFilter;
+use Illuminate\Support\Facades\App;
+
+class BrowserDetector implements Detector
+{
+    /**
+     * Detect the locale.
+     *
+     * @return string|array|null
+     */
+    public function detect()
+    {
+        return App::make(BrowserLocale::class)->filter(new CombinedFilter);
+    }
+}

src/Middleware/Detectors/CookieDetector.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace CodeZero\LocalizedRoutes\Middleware\Detectors;
+
+use Illuminate\Support\Facades\Config;
+use Illuminate\Support\Facades\Cookie;
+
+class CookieDetector implements Detector
+{
+    /**
+     * Detect the locale.
+     *
+     * @return string|array|null
+     */
+    public function detect()
+    {
+        $key = Config::get('localized-routes.cookie_name');
+
+        return Cookie::get($key);
+    }
+}

src/Middleware/Detectors/Detector.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace CodeZero\LocalizedRoutes\Middleware\Detectors;
+
+interface Detector
+{
+    /**
+     * Detect the locale.
+     *
+     * @return string|array|null
+     */
+    public function detect();
+}

src/Middleware/Detectors/OmittedLocaleDetector.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace CodeZero\LocalizedRoutes\Middleware\Detectors;
+
+use Illuminate\Support\Facades\Config;
+
+class OmittedLocaleDetector implements Detector
+{
+    /**
+     * Detect the locale.
+     *
+     * @return string|array|null
+     */
+    public function detect()
+    {
+        return Config::get('localized-routes.omitted_locale') ?: null;
+    }
+}

src/Middleware/Detectors/RouteActionDetector.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace CodeZero\LocalizedRoutes\Middleware\Detectors;
+
+use Illuminate\Support\Facades\Config;
+use Illuminate\Support\Facades\Request;
+
+class RouteActionDetector implements Detector
+{
+    /**
+     * Detect the locale.
+     *
+     * @return string|array|null
+     */
+    public function detect()
+    {
+        $action = Config::get('localized-routes.route_action');
+
+        return Request::route()->getAction($action);
+    }
+}

src/Middleware/Detectors/SessionDetector.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace CodeZero\LocalizedRoutes\Middleware\Detectors;
+
+use Illuminate\Support\Facades\Config;
+use Illuminate\Support\Facades\Session;
+
+class SessionDetector implements Detector
+{
+    /**
+     * Detect the locale.
+     *
+     * @return string|array|null
+     */
+    public function detect()
+    {
+        $key = Config::get('localized-routes.session_key');
+
+        return Session::get($key);
+    }
+}