add translation.loader

Author: samehdoush

src/LaravelTranslationsApiServiceProvider.php

@@ -43,4 +43,13 @@ public function configurePackage(Package $package): void
                     });
             });
     }
+    // registerLoader
+    public function registeringPackage()
+    {
+        $this->app->singleton('translation.loader', function ($app) {
+            $class = TranslationLoaderManager::class;
+
+            return new $class($app['files'], $app['path.lang']);
+        });
+    }
 }

src/Models/Phrase.php

@@ -5,8 +5,10 @@
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Support\Facades\Cache;
 use Samehdoush\LaravelTranslationsApi\Models\Concerns\HasDatabaseConnection;
 use Samehdoush\LaravelTranslationsApi\Models\Concerns\HasUuid;
+use Illuminate\Support\Arr;
 
 class Phrase extends Model
 {
@@ -25,7 +27,17 @@ class Phrase extends Model
     protected $with = [
         'source',
     ];
+    public static function boot()
+    {
+        parent::boot();
+
+        $flushGroupCache = function (self $languageLine) {
+            $languageLine->flushGroupCache();
+        };
 
+        static::saved($flushGroupCache);
+        static::deleted($flushGroupCache);
+    }
     public function file(): BelongsTo
     {
         return $this->belongsTo(TranslationFile::class, 'translation_file_id');
@@ -40,4 +52,56 @@ public function translation(): BelongsTo
     {
         return $this->belongsTo(Translation::class);
     }
+
+    public static function getTranslationsForGroup(string $locale, string $group): array
+    {
+        return Cache::rememberForever(static::getCacheKey($group, $locale), function () use ($group, $locale) {
+            return static::query()
+                ->where('group', $group)
+                ->get()
+                ->reduce(function ($lines, self $languageLine) use ($group, $locale) {
+                    // $translation = $languageLine->getTranslation($locale);
+                    $translation = $languageLine->value;
+
+                    if ($translation !== null && $group === '*') {
+                        // Make a flat array when returning json translations
+                        $lines[$languageLine->key] = $translation;
+                    } elseif ($translation !== null && $group !== '*') {
+                        // Make a nested array when returning normal translations
+                        Arr::set($lines, $languageLine->key, $translation);
+                    }
+
+                    return $lines;
+                }) ?? [];
+        });
+    }
+
+    // public function getTranslation(string $locale): ?string
+    // {
+    //     if (!isset($this->text[$locale])) {
+    //         $fallback = config('app.fallback_locale');
+
+    //         return $this->text[$fallback] ?? null;
+    //     }
+
+    //     return $this->text[$locale];
+    // }
+    public static function getCacheKey(string $group, string $locale): string
+    {
+        return "samehdoush.translation-loader.{$group}.{$locale}";
+    }
+    public function flushGroupCache()
+    {
+        foreach ($this->getTranslatedLocales() as $locale) {
+            Cache::forget(static::getCacheKey($this->group, $locale));
+        }
+    }
+
+    protected function getTranslatedLocales(): array
+    {
+        return Translation::with('language')
+            ->get()
+            ->pluck('language.code')
+            ->toArray();
+    }
 }

src/TranslationLoaderManager.php

@@ -0,0 +1,62 @@
+<?php
+
+namespace Samehdoush\LaravelTranslationsApi;
+
+use Illuminate\Database\QueryException;
+use Illuminate\Translation\FileLoader;
+use Illuminate\Support\Facades\Schema;
+use Samehdoush\LaravelTranslationsApi\Models\Phrase;
+use Samehdoush\LaravelTranslationsApi\TranslationLoaders\Db;
+use Samehdoush\LaravelTranslationsApi\TranslationLoaders\TranslationLoader;
+
+class TranslationLoaderManager extends FileLoader
+{
+    /**
+     * Load the messages for the given locale.
+     *
+     * @param string $locale
+     * @param string $group
+     * @param string $namespace
+     *
+     * @return array
+     */
+    public function load($locale, $group, $namespace = null): array
+    {
+        try {
+            $fileTranslations = parent::load($locale, $group, $namespace);
+
+            if (!is_null($namespace) && $namespace !== '*') {
+                return $fileTranslations;
+            }
+
+            $loaderTranslations = $this->getTranslationsForTranslationLoaders($locale, $group, $namespace);
+
+            return array_replace_recursive($fileTranslations, $loaderTranslations);
+        } catch (QueryException $e) {
+            $modelClass = Phrase::class;
+            $model = new $modelClass;
+            if (is_a($model, Phrase::class)) {
+                if (!Schema::hasTable($model->getTable())) {
+                    return parent::load($locale, $group, $namespace);
+                }
+            }
+
+            throw $e;
+        };
+    }
+
+    protected function getTranslationsForTranslationLoaders(
+        string $locale,
+        string $group,
+        string $namespace = null
+    ): array {
+        return collect(Db::class)
+            ->map(function (string $className) {
+                return app($className);
+            })
+            ->mapWithKeys(function (TranslationLoader $translationLoader) use ($locale, $group, $namespace) {
+                return $translationLoader->loadTranslations($locale, $group, $namespace);
+            })
+            ->toArray();
+    }
+}

src/TranslationLoaders/Db.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Samehdoush\LaravelTranslationsApi\TranslationLoaders;
+
+use Samehdoush\LaravelTranslationsApi\Models\Phrase;
+
+
+class Db implements TranslationLoader
+{
+    public function loadTranslations(string $locale, string $group): array
+    {
+
+
+        return Phrase::getTranslationsForGroup($locale, $group);
+    }
+
+
+}

src/TranslationLoaders/TranslationLoader.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Samehdoush\LaravelTranslationsApi\TranslationLoaders;
+
+interface TranslationLoader
+{
+    /**
+     * Returns all translations for the given locale and group.
+     *
+     * @param string $locale
+     * @param string $group
+     *
+     * @return array
+     */
+    public function loadTranslations(string $locale, string $group): array;
+}