Added property that always converts back to the original type

Author: eluhr

src/behaviors/JsonAttributeBehavior.php

@@ -31,6 +31,7 @@
  *
  * @property Model $owner
  * @property string[] $_convertedAttributes
+ * @property bool $alwaysConvertBackToOriginalType
  */
 class JsonAttributeBehavior extends AttributeBehavior
 {
@@ -41,6 +42,13 @@ class JsonAttributeBehavior extends AttributeBehavior
      */
     private array $_convertedAttributes = [];
 
+    /**
+     * Whether to always convert the attribute back to its original type, even if no validation errors occur.
+     *
+     * @var bool
+     */
+    public bool $alwaysConvertBackToOriginalType = false;
+
     /**
      * @inheritdoc
      */
@@ -77,10 +85,10 @@ public function beforeValidate(): void
      */
     public function afterValidate(): void
     {
-        if ($this->owner->hasErrors()) {
+        if ($this->owner->hasErrors() || $this->alwaysConvertBackToOriginalType) {
             foreach ($this->attributes as $attribute) {
                 // If the attribute was originally a string, convert it back to a string.
-                if (in_array($this->owner->$attribute, $this->_convertedAttributes)) {
+                if (in_array($attribute, $this->_convertedAttributes)) {
                     // Convert the attribute back to its original type.
                     $this->owner->$attribute = Json::encode($this->owner->$attribute);
                     // Remove the attribute from the list of converted attributes.

tests/JsonAttributeBehaviorTest.php

@@ -44,6 +44,13 @@ public function testValueIsOriginalTypeAfterValidationForArray(): void
         $item->validate();
         $this->assertIsArray($item->data_json);
     }
+
+    public function testValueIsOriginalTypeAfterValidationForStringButConvertBackToString(): void
+    {
+        $item = new Item2(['data_json' => '{"a": "b"}']);
+        $item->validate();
+        $this->assertIsString($item->data_json);
+    }
 }
 
 class Item extends Model
@@ -92,3 +99,16 @@ public function rules(): array
         return $rules;
     }
 }
+
+class Item2 extends Item {
+
+    /**
+     * @inheritdoc
+     */
+    public function behaviors(): array
+    {
+        $behaviors = parent::behaviors();
+        $behaviors['json-attribute']['alwaysConvertBackToOriginalType'] = true;
+        return $behaviors;
+    }
+}