Centralize configuration queries to a dedicated class (#79)

Author: ivanvermeyen

src/Facades/LocaleConfig.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace CodeZero\LocalizedRoutes\Facades;
+
+use Illuminate\Support\Facades\Facade;
+
+/**
+ * LocaleConfig Facade
+ *
+ * @mixin \CodeZero\LocalizedRoutes\LocaleConfig
+ */
+class LocaleConfig extends Facade
+{
+    /**
+     * Get the registered name of the component.
+     *
+     * @return string
+     */
+    protected static function getFacadeAccessor()
+    {
+        return 'locale-config';
+    }
+}

src/Illuminate/Routing/UrlGenerator.php

@@ -2,9 +2,9 @@
 
 namespace CodeZero\LocalizedRoutes\Illuminate\Routing;
 
+use CodeZero\LocalizedRoutes\Facades\LocaleConfig;
 use Illuminate\Routing\UrlGenerator as BaseUrlGenerator;
 use Illuminate\Support\Facades\App;
-use Illuminate\Support\Facades\Config;
 use Illuminate\Support\Facades\Route;
 
 class UrlGenerator extends BaseUrlGenerator
@@ -99,8 +99,8 @@ protected function resolveLocalizedRouteName($name, $locale, $currentLocale)
 
         // If the locale is not supported, use a fallback
         // locale if one is configured.
-        if ( ! $this->isSupportedLocale($locale)) {
-            $locale = $this->getFallbackLocale() ?: $locale;
+        if ( ! LocaleConfig::isSupportedLocale($locale)) {
+            $locale = LocaleConfig::getFallbackLocale() ?: $locale;
         }
 
         // Normalize the route name by removing any locale prefix.
@@ -140,7 +140,7 @@ protected function stripLocaleFromRouteName($name)
 
         // If the first part of the route name is a valid
         // locale, then remove it from the array.
-        if ($this->isSupportedLocale($parts[0])) {
+        if (LocaleConfig::isSupportedLocale($parts[0])) {
             array_shift($parts);
         }
 
@@ -149,42 +149,4 @@ protected function stripLocaleFromRouteName($name)
 
         return $name;
     }
-
-    /**
-     * Check if the given locale is supported.
-     *
-     * @param string $locale
-     *
-     * @return bool
-     */
-    protected function isSupportedLocale($locale)
-    {
-        return in_array($locale, $this->getSupportedLocales());
-    }
-
-    /**
-     * Get the supported locales and not the custom slugs or domains.
-     *
-     * @return array
-     */
-    protected function getSupportedLocales()
-    {
-        $locales = Config::get('localized-routes.supported_locales', []);
-
-        if (is_numeric(key($locales))) {
-            return $locales;
-        }
-
-        return array_keys($locales);
-    }
-
-    /**
-     * Get the fallback locale.
-     *
-     * @return string|null
-     */
-    protected function getFallbackLocale()
-    {
-        return Config::get('localized-routes.fallback_locale');
-    }
 }

src/LocaleConfig.php

@@ -0,0 +1,207 @@
+<?php
+
+namespace CodeZero\LocalizedRoutes;
+
+class LocaleConfig
+{
+    /**
+     * The configured supported locales.
+     *
+     * @var array
+     */
+    protected $supportedLocales;
+
+    /**
+     * The configured omitted locale.
+     *
+     * @var string|null
+     */
+    protected $omittedLocale;
+
+    /**
+     * The configured fallback locale.
+     *
+     * @var string|null
+     */
+    protected $fallbackLocale;
+
+    /**
+     * The configured route action that holds a route's locale.
+     *
+     * @var string
+     */
+    protected $routeAction;
+
+    /**
+     * Create a new LocaleConfig instance.
+     *
+     * @param array $config
+     */
+    public function __construct($config = [])
+    {
+        $this->supportedLocales = $config['supported_locales'] ?? [];
+        $this->omittedLocale = $config['omitted_locale'] ?? null;
+        $this->fallbackLocale = $config['fallback_locale'] ?? null;
+        $this->routeAction = $config['route_action'] ?? null;
+    }
+
+    /**
+     * Get the configured supported locales.
+     *
+     * @return array
+     */
+    public function getSupportedLocales()
+    {
+        return $this->supportedLocales;
+    }
+
+    /**
+     * Set the supported locales.
+     *
+     * @param array $locales
+     *
+     * @return void
+     */
+    public function setSupportedLocales($locales)
+    {
+        $this->supportedLocales = $locales;
+    }
+
+    /**
+     * Get the locale that should be omitted in the URI path.
+     *
+     * @return string|null
+     */
+    public function getOmittedLocale()
+    {
+        return $this->omittedLocale;
+    }
+
+    /**
+     * Set the locale that should be omitted in the URI path.
+     *
+     * @param string|null $locale
+     *
+     * @return void
+     */
+    public function setOmittedLocale($locale)
+    {
+        $this->omittedLocale = $locale;
+    }
+
+    /**
+     * Get the fallback locale.
+     *
+     * @return string|null
+     */
+    public function getFallbackLocale()
+    {
+        return $this->fallbackLocale;
+    }
+
+    /**
+     * Set the fallback locale.
+     *
+     * @param string|null $locale
+     *
+     * @return void
+     */
+    public function setFallbackLocale($locale)
+    {
+        $this->fallbackLocale = $locale;
+    }
+
+    /**
+     * Get the route action that holds a route's locale.
+     *
+     * @return string
+     */
+    public function getRouteAction()
+    {
+        return $this->routeAction;
+    }
+
+    /**
+     * Set the route action that holds a route's locale.
+     *
+     * @param string $locale
+     *
+     * @return string
+     */
+    public function setRouteAction($locale)
+    {
+        return $this->routeAction = $locale;
+    }
+
+    /**
+     * Get the locales (not the slugs or domains).
+     *
+     * @return array
+     */
+    public function getLocales()
+    {
+        $locales = $this->getSupportedLocales();
+
+        if ($this->hasSimpleLocales()) {
+            return $locales;
+        }
+
+        return array_keys($locales);
+    }
+
+    /**
+     * Check if there are any locales configured.
+     *
+     * @return bool
+     */
+    public function hasLocales()
+    {
+        return count($this->getSupportedLocales()) > 0;
+    }
+
+    /**
+     * Check if there are only locales configured,
+     * and not custom slugs or domains.
+     *
+     * @return bool
+     */
+    public function hasSimpleLocales()
+    {
+        return is_numeric(key($this->getSupportedLocales()));
+    }
+
+    /**
+     * Check if custom slugs are configured.
+     *
+     * @return bool
+     */
+    public function hasCustomSlugs()
+    {
+        return $this->hasLocales() && ! $this->hasSimpleLocales() && ! $this->hasCustomDomains();
+    }
+
+    /**
+     * Check if custom domains are configured.
+     *
+     * @return bool
+     */
+    public function hasCustomDomains()
+    {
+        $firstValue = array_values($this->getSupportedLocales())[0] ?? '';
+        $containsDot =  strpos($firstValue, '.') !== false;
+
+        return $containsDot;
+    }
+
+    /**
+     * Check if the given locale is supported.
+     *
+     * @param string $locale
+     *
+     * @return bool
+     */
+    public function isSupportedLocale($locale)
+    {
+        return in_array($locale, $this->getLocales());
+    }
+}