bugfix: loading all translations of a model as a collection

Author: hamidgh83

src/Traits/TranslatableTrait.php

@@ -2,24 +2,25 @@
 
 namespace Jetcod\Laravel\Translation\Traits;
 
-use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\MorphMany;
 use Illuminate\Database\Eloquent\Relations\MorphOne;
+use Illuminate\Support\Collection;
 use Jetcod\Laravel\Translation\Models\Translation;
 
 trait TranslatableTrait
 {
-    private $cachedModel;
+    private $cachedTranslationModels;
 
     public function __get($key)
     {
         if ($this->isRelation($key)) {
             return $this->getRelationValue($key);
         }
 
-        // Check if the attribute is translatable
-        if ($translation = $this->getTranslation($key)) {
-            return $translation;
+        // Check if the attribute translation exists
+        $translation = $this->getTranslation($key);
+        if ($translation instanceof Translation) {
+            return $translation->value;
         }
 
         // Fallback to the default behavior
@@ -37,9 +38,12 @@ public function translations(): MorphMany
     }
 
     /**
-     * Returns translatable attribute(s).
+     * Retrieves the list of attributes that are translatable for the current model.
      *
-     * @return null|array|string
+     * If the `TRANSLATABLE_ATTRIBUTES` constant is defined on the model, it will be returned.
+     * Otherwise, `null` will be returned, indicating that all attributes are translatable.
+     *
+     * @return null|array the list of translatable attributes, or `null` if all attributes are translatable
      */
     protected function getTranslatableAttributes()
     {
@@ -50,19 +54,31 @@ protected function getTranslatableAttributes()
         return null;
     }
 
-    private function getTranslation(string $key): ?string
+    /**
+     * Retrieves the translation for the given attribute key, if the attribute is translatable.
+     *
+     * @param string $key the attribute key to retrieve the translation for
+     *
+     * @return null|Translation the translation model, or null if the attribute is not translatable
+     */
+    private function getTranslation(string $key): ?Translation
     {
         if ($this->isTranslatableAttribute($key)) {
-            $model = $this->getCachedModel();
+            $collection = $this->getCachedTranslations();
 
-            if ($model instanceof Model) {
-                return $key == $model->key ? $model->value : null;
-            }
+            return $collection->firstWhere('key', $key);
         }
 
         return null;
     }
 
+    /**
+     * Determines whether the given attribute key is a translatable attribute.
+     *
+     * @param string $key the attribute key to check
+     *
+     * @return bool `true` if the attribute is translatable, `false` otherwise
+     */
     private function isTranslatableAttribute(string $key): bool
     {
         $translatables = $this->getTranslatableAttributes();
@@ -74,8 +90,13 @@ private function isTranslatableAttribute(string $key): bool
         return is_array($translatables) ? in_array($key, $translatables) : $key == $translatables;
     }
 
-    private function getCachedModel()
+    /**
+     * Retrieves the cached translation models for the current locale.
+     *
+     * @return Collection the collection of translation models
+     */
+    private function getCachedTranslations(): Collection
     {
-        return $this->cachedModel = $this->cachedModel ?: $this->translation()->locale(app()->getLocale())->first();
+        return $this->cachedTranslationModels = $this->cachedTranslationModels ?: $this->translation()->locale(app()->getLocale())->get();
     }
 }

tests/TranslationModelTest.php

@@ -79,6 +79,59 @@ public function testItReturnsOriginalTextWhenNoTranslationIsAvailable()
         $this->assertEquals('original text goes here', $post->name);
     }
 
+    public function testItTranslatesOnlyTranslatableAttributes()
+    {
+        $post = new class() extends Post {
+            protected const TRANSLATABLE_ATTRIBUTES = 'name';
+        };
+        $post->id   = 1;
+        $post->name = 'original text goes here';
+        $post->body = 'some text goes here';
+
+        $post->translation()->saveMany([
+            new Translation([
+                'locale' => 'fr_FR',
+                'key'    => 'name',
+                'value'  => 'un texte va ici',
+            ]),
+        ]);
+
+        app()->setLocale('fr_FR');
+        $this->assertEquals('un texte va ici', $post->name);
+        $this->assertEquals('some text goes here', $post->body);
+    }
+
+    public function testItTranslatesAllAttributesIfNoTranslatableAttributesAreDefined()
+    {
+        $post = new class() extends Post {
+            protected function getTranslatableAttributes()
+            {
+                return null;
+            }
+        };
+        $post->id   = 1;
+        $post->name = 'some text goes here';
+        $post->body = 'another text goes here';
+
+        app()->setLocale('fr_FR');
+        $post->translation()->saveMany([
+            new Translation([
+                'locale' => 'fr_FR',
+                'key'    => 'name',
+                'value'  => 'un texte va ici',
+            ]),
+            new Translation([
+                'locale' => 'fr_FR',
+                'key'    => 'body',
+                'value'  => 'un autre texte va ici',
+            ]),
+        ]);
+
+        app()->setLocale('fr_FR');
+        $this->assertEquals('un texte va ici', $post->name);
+        $this->assertEquals('un autre texte va ici', $post->body);
+    }
+
     public function testItReturnsTranslationsCollection()
     {
         $post       = new Post();