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

system/Entity/Entity.php

@@ -227,7 +227,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;
  }
 
@@ -268,22 +268,45 @@ 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();
  }
 
- $dbColumn = $this->mapProperty($key);
+ $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 (array_keys($this->attributes) as $key) {
+ if ($this->isChanged($key)) {
+ return true;
+ }
+ }
+
+ return false;
+ }
 
  // Key doesn't exist in either
- if (! array_key_exists($dbColumn, $this->original) && ! array_key_exists($dbColumn, $this->attributes)) {
+ if (! array_key_exists($key, $this->original) && ! array_key_exists($key, $this->attributes)) {
  return false;
  }
 
  // It's a new element
- if (! array_key_exists($dbColumn, $this->original) && array_key_exists($dbColumn, $this->attributes)) {
+ if (! array_key_exists($key, $this->original) && array_key_exists($key, $this->attributes)) {
  return true;
  }
 
- return $this->original[$dbColumn] !== $this->attributes[$dbColumn];
+ return $this->isChanged($key);
  }
 
  /**
@@ -526,7 +549,6 @@ public function __get(string $key)
  // If a "`get` + $key" method exists, it is also a getter.
  $result = $this->{$method}();
  }
-
  // Otherwise return the protected property
  // if it exists.
  elseif (array_key_exists($dbColumn, $this->attributes)) {
@@ -545,6 +567,28 @@ public function __get(string $key)
  return $result;
  }
 
+ /**
+ * Get cast value from the data array.
+ *
+ * @return array|bool|float|int|object|string|null
+ */
+ private function _getCastData(string $key, array $data)
+ {
+ if (array_key_exists($key, $data)) {
+ return $this->castAs($data[$key], $key);
+ }
+
+ return null;
+ }
+
+ /**
+ * 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

@@ -1032,6 +1032,51 @@ public function testHasChangedMappedChanged(): void
  $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(): void
  {
  $entity = $this->getEntity();