fix: Entity::hasChanged() is unreliable for casts

Author: kenjis

system/Entity/Entity.php

@@ -189,7 +189,7 @@ public function toArray(bool $onlyChanged = false, bool $cast = true, bool $recu
      * Returns the raw values of the current attributes.
      *
      * @param bool $onlyChanged If true, only return values that have changed since object creation
-     * @param bool $recursive   If true, inner entities will be casted as array as well.
+     * @param bool $recursive   If true, inner entities will be cast as array as well.
      */
     public function toRawArray(bool $onlyChanged = false, bool $recursive = false): array
     {
@@ -212,7 +212,7 @@ public function toRawArray(bool $onlyChanged = false, bool $recursive = false):
         }
 
         foreach ($this->attributes as $key => $value) {
-            if (! $this->hasChanged($key)) {
+            if (! $this->hasChangedAttributes($key)) {
                 continue;
             }
 
@@ -247,17 +247,40 @@ public function syncOriginal()
      * was created. Or, without a parameter, checks if any
      * properties have changed.
      *
-     * @param string $key
+     * @param string|null $key class property
      */
     public function hasChanged(?string $key = null): bool
     {
         // If no parameter was given then check all attributes
         if ($key === null) {
-            return $this->original !== $this->attributes;
+            return $this->hasChangedAttributes();
         }
 
         $key = $this->mapProperty($key);
 
+        return $this->hasChangedAttributes($key);
+    }
+
+    /**
+     * Checks a attribute to see if it has changed since the entity
+     * was created. Or, without a parameter, checks if any
+     * attributes have changed.
+     *
+     * @param string|null $key key of $this->attributes
+     */
+    private function hasChangedAttributes(?string $key = null): bool
+    {
+        // If no parameter was given then check all attributes
+        if ($key === null) {
+            foreach ($this->attributes as $key => $value) {
+                if ($this->isChanged($key)) {
+                    return true;
+                }
+            }
+
+            return false;
+        }
+
         // Key doesn't exist in either
         if (! array_key_exists($key, $this->original) && ! array_key_exists($key, $this->attributes)) {
             return false;
@@ -268,7 +291,7 @@ public function hasChanged(?string $key = null): bool
             return true;
         }
 
-        return $this->original[$key] !== $this->attributes[$key];
+        return $this->isChanged($key);
     }
 
     /**
@@ -470,6 +493,7 @@ public function __set(string $key, $value = null)
      *  $p = $this->getMyProperty()
      *
      * @throws Exception
+     * @params string $key class property
      *
      * @return mixed
      */
@@ -487,7 +511,6 @@ public function __get(string $key)
         if (method_exists($this, $method)) {
             $result = $this->{$method}();
         }
-
         // Otherwise return the protected property
         // if it exists.
         elseif (array_key_exists($key, $this->attributes)) {
@@ -506,6 +529,30 @@ public function __get(string $key)
         return $result;
     }
 
+    /**
+     * Get cast value from the data array.
+     *
+     * @return mixed|null
+     */
+    private function _getCastData(string $key, array $data)
+    {
+        $result = null;
+
+        if (array_key_exists($key, $data)) {
+            $result = $this->castAs($data[$key], $key);
+        }
+
+        return $result;
+    }
+
+    /**
+     * Check if the key value is changed.
+     */
+    private function isChanged(string $key): bool
+    {
+        return $this->_getCastData($key, $this->original) !== $this->_getCastData($key, $this->attributes);
+    }
+
     /**
      * Returns true if a property exists names $key, or a getter method
      * exists named like for __get().

tests/system/Entity/EntityTest.php

@@ -947,6 +947,51 @@ public function testHasChangedMappedChanged()
         $this->assertTrue($entity->hasChanged('createdAt'));
     }
 
+    /**
+     * @see https://github.com/codeigniter4/CodeIgniter4/issues/5905
+     */
+    public function testHasChangedCastsItem()
+    {
+        $data = [
+            'id'   => '1',
+            'name' => 'John',
+            'age'  => '35',
+        ];
+        $entity              = new class ($data) extends \CodeIgniter\Entity {
+            protected $casts = [
+                'id'   => 'integer',
+                'name' => 'string',
+                'age'  => 'integer',
+            ];
+        };
+        $entity->syncOriginal();
+
+        $entity->age = 35;
+
+        $this->assertFalse($entity->hasChanged('age'));
+    }
+
+    public function testHasChangedCastsWholeEntity()
+    {
+        $data = [
+            'id'   => '1',
+            'name' => 'John',
+            'age'  => '35',
+        ];
+        $entity              = new class ($data) extends \CodeIgniter\Entity {
+            protected $casts = [
+                'id'   => 'integer',
+                'name' => 'string',
+                'age'  => 'integer',
+            ];
+        };
+        $entity->syncOriginal();
+
+        $entity->age = 35;
+
+        $this->assertFalse($entity->hasChanged());
+    }
+
     public function testHasChangedWholeEntity()
     {
         $entity = $this->getEntity();