Extended translations system for arrays & extension

Extended the base Laravel translation system to
allow a locale to be based upon another.

Also adds functionality to take base & fallback locales into account when fetching
an array of translations.

Related to work done in #1159

app/Http/Controllers/HomeController.php

@@ -79,6 +79,7 @@ class HomeController extends Controller
     {
         $locale = app()->getLocale();
         $cacheKey = 'GLOBAL_TRANSLATIONS_' . $locale;
+
         if (cache()->has($cacheKey) && config('app.env') !== 'development') {
             $resp = cache($cacheKey);
         } else {
@@ -89,15 +90,6 @@ class HomeController extends Controller
                 'entities' => trans('entities'),
                 'errors' => trans('errors')
             ];
-            if ($locale !== 'en') {
-                $enTrans = [
-                    'common' => trans('common', [], 'en'),
-                    'components' => trans('components', [], 'en'),
-                    'entities' => trans('entities', [], 'en'),
-                    'errors' => trans('errors', [], 'en')
-                ];
-                $translations = array_replace_recursive($enTrans, $translations);
-            }
             $resp = 'window.translations = ' . json_encode($translations);
             cache()->put($cacheKey, $resp, 120);
         }

app/Providers/TranslationServiceProvider.php

@@ -0,0 +1,32 @@
+<?php namespace BookStack\Providers;
+
+
+use BookStack\Translation\Translator;
+
+class TranslationServiceProvider extends \Illuminate\Translation\TranslationServiceProvider
+{
+    /**
+     * Register the service provider.
+     *
+     * @return void
+     */
+    public function register()
+    {
+        $this->registerLoader();
+
+        $this->app->singleton('translator', function ($app) {
+            $loader = $app['translation.loader'];
+
+            // When registering the translator component, we'll need to set the default
+            // locale as well as the fallback locale. So, we'll grab the application
+            // configuration so we can easily get both of these values from there.
+            $locale = $app['config']['app.locale'];
+
+            $trans = new Translator($loader, $locale);
+
+            $trans->setFallback($app['config']['app.fallback_locale']);
+
+            return $trans;
+        });
+    }
+}

app/Translation/Translator.php

@@ -0,0 +1,74 @@
+<?php namespace BookStack\Translation;
+
+
+class Translator extends \Illuminate\Translation\Translator
+{
+
+    /**
+     * Mapping of locales to their base locales
+     * @var array
+     */
+    protected $baseLocaleMap = [
+        'de_informal' => 'de',
+    ];
+
+    /**
+     * Get the translation for a given key.
+     *
+     * @param  string  $key
+     * @param  array   $replace
+     * @param  string  $locale
+     * @return string|array|null
+     */
+    public function trans($key, array $replace = [], $locale = null)
+    {
+        $translation = $this->get($key, $replace, $locale);
+
+        if (is_array($translation)) {
+            $translation = $this->mergeBackupTranslations($translation, $key, $locale);
+        }
+
+        return $translation;
+    }
+
+    /**
+     * Merge the fallback translations, and base translations if existing,
+     * into the provided core key => value array of translations content.
+     * @param array $translationArray
+     * @param string $key
+     * @param null $locale
+     * @return array
+     */
+    protected function mergeBackupTranslations(array $translationArray, string $key, $locale = null)
+    {
+        $fallback = $this->get($key, [], $this->fallback);
+        $baseLocale = $this->getBaseLocale($locale ?? $this->locale);
+        $baseTranslations = $baseLocale ? $this->get($key, [], $baseLocale) : [];
+
+        return array_replace_recursive($fallback, $baseTranslations, $translationArray);
+    }
+
+    /**
+     * Get the array of locales to be checked.
+     *
+     * @param  string|null  $locale
+     * @return array
+     */
+    protected function localeArray($locale)
+    {
+        $primaryLocale = $locale ?: $this->locale;
+        return array_filter([$primaryLocale, $this->getBaseLocale($primaryLocale), $this->fallback]);
+    }
+
+    /**
+     * Get the locale to extend for the given locale.
+     *
+     * @param string $locale
+     * @return string|null
+     */
+    protected function getBaseLocale($locale)
+    {
+        return $this->baseLocaleMap[$locale] ?? null;
+    }
+
+}