Merge pull request #99 from RichWeber/patch-1

Improve TranslateBehavior saving

Author: moltam

README.md

@@ -420,7 +420,17 @@ class Category extends \yii\db\ActiveRecord {
 
 * With behavior (since 1.5.3):
 
-    **Note:** This will replace the model's original attribute values!
+    This behavior does the following:
+    - Replaces the specified attributes with translations after the model is loaded.
+    - Saves the attribute values as:
+        1. Source messages, if the current language is the source language.
+        2. Translations, if the current language is different from the source language.
+           This way the value stored in database is not overwritten with the translation.
+
+    **Note**: If the model should be saved as translation, but the source message does not exist yet in the database
+    then the message is saved as the source message whether the current language is the source language or not.
+    To avoid this scan the database for existing messages when using the behavior first, and only save new records
+    when the current language is the source language.
 
 ```php
 namespace common\models;

behaviors/TranslateBehavior.php

@@ -6,9 +6,23 @@
 use yii\db\BaseActiveRecord;
 use yii\behaviors\AttributeBehavior;
 use lajax\translatemanager\helpers\Language;
+use lajax\translatemanager\models\LanguageSource;
+use lajax\translatemanager\models\LanguageTranslate;
 
 /**
- * TranslateManager Database translate behavior.
+ * Behavior that translates the model attributes, and saves the changes into database.
+ *
+ * This behavior does the following:
+ *  - Replaces the specified attributes with translations after the model is loaded.
+ *  - Saves the attribute values as:
+ *      1. Source messages, if the current language is the source language.
+ *      2. Translations, if the current language is different from the source language.
+ *         This way the value stored in database is not overwritten with the translation.
+ *
+ * **Note**: If the model should be saved as translation, but the source message does not exist yet in the database
+ * then the message is saved as the source message whether the current language is the source language or not.
+ * To avoid this scan the database for existing messages when using the behavior first, and only save new records
+ * when the current language is the source language.
  *
  * Installation:
  *
@@ -45,6 +59,11 @@ class TranslateBehavior extends AttributeBehavior
      */
     public $category = 'database';
 
+    /**
+     * @var BaseActiveRecord the owner model of this behavior
+     */
+    public $owner;
+
     /**
      * @inheritdoc
      */
@@ -68,31 +87,88 @@ public function events()
     }
 
     /**
-     * Translates a message to the specified language.
+     * Translates the attributes to the current language.
      *
      * @param \yii\base\Event $event
      */
     public function translateAttributes($event)
     {
-        /* @var $owner BaseActiveRecord */
-        $owner = $this->owner;
         foreach ($this->translateAttributes as $attribute) {
-            $owner->{$attribute} = Yii::t($this->category, $owner->attributes[$attribute]);
+            $this->owner->{$attribute} = Yii::t($this->category, $this->owner->attributes[$attribute]);
         }
     }
 
     /**
-     * Saveing new language element by category.
+     * Saves new language element by category.
      *
      * @param \yii\base\Event $event
      */
     public function saveAttributes($event)
     {
-        /* @var $owner BaseActiveRecord */
-        $owner = $this->owner;
+        $isAppInSourceLanguage = Yii::$app->sourceLanguage === Yii::$app->language;
+
         foreach ($this->translateAttributes as $attribute) {
-            if ($owner->isAttributeChanged($attribute)) {
-                Language::saveMessage($owner->attributes[$attribute], $this->category);
+            if (!$this->owner->isAttributeChanged($attribute)) {
+                continue;
+            }
+
+            if ($isAppInSourceLanguage || !$this->saveAttributeValueAsTranslation($attribute)) {
+                Language::saveMessage($this->owner->attributes[$attribute], $this->category);
+            }
+        }
+    }
+
+    /**
+     * @param string $attribute The name of the attribute.
+     *
+     * @return bool Whether the translation is saved.
+     */
+    private function saveAttributeValueAsTranslation($attribute)
+    {
+        $sourceMessage = $this->owner->getOldAttribute($attribute);
+        $translatedMessage = $this->owner->attributes[$attribute];
+
+        // Restore the original value, so it won't be replaced with the translation in the database.
+        $this->owner->{$attribute} = $sourceMessage;
+
+        $translateSource = $this->findSourceMessage($sourceMessage);
+        if (!$translateSource) {
+            return false; // The source does not exist, the message cannot be saved as translation.
+        }
+
+        $translation = new LanguageTranslate();
+        foreach ($translateSource->languageTranslates as $tmpTranslate) {
+            if ($tmpTranslate->language === Yii::$app->language) {
+                $translation = $tmpTranslate;
+                break;
+            }
+        }
+
+        if ($translation->isNewRecord) {
+            $translation->id = $translateSource->id;
+            $translation->language = Yii::$app->language;
+        }
+
+        $translation->translation = $translatedMessage;
+        $translation->save();
+
+        return true;
+    }
+
+    /**
+     * Finds the source record with case sensitive match.
+     *
+     * @param string $message
+     *
+     * @return LanguageSource|null Null if the source is not found.
+     */
+    private function findSourceMessage($message)
+    {
+        $sourceMessages = LanguageSource::findAll(['message' => $message, 'category' => $this->category]);
+
+        foreach ($sourceMessages as $source) {
+            if ($source->message === $message) {
+                return $source;
             }
         }
     }