Merge pull request #2004 from MGatner/entity-haschanged-whole

Allow hasChanged() without parameter

Author: lonnieezell

system/Entity.php

@@ -236,13 +236,20 @@ public function syncOriginal()
 
 	/**
 	 * Checks a property to see if it has changed since the entity was created.
+	 * Or, without a parameter, checks if any properties have changed.
 	 *
-	 * @param string $key
+	 * @param ?string $key
 	 *
 	 * @return boolean
 	 */
-	public function hasChanged(string $key): bool
+	public function hasChanged(string $key = null): bool
 	{
+		// If no parameter was given then check all attributes
+		if ($key === null)
+		{
+			return 	$this->original !== $this->attributes;
+		}
+		
 		// Key doesn't exist in either
 		if (! array_key_exists($key, $this->original) && ! array_key_exists($key, $this->attributes))
 		{

tests/system/EntityTest.php

@@ -664,6 +664,15 @@ public function testHasChangedNoChange()
 		$this->assertFalse($entity->hasChanged('default'));
 	}
 
+	public function testHasChangedWholeEntity()
+	{
+		$entity = $this->getEntity();
+		
+		$entity->foo = 'bar';
+
+		$this->assertTrue($entity->hasChanged());
+	}
+
 	protected function getEntity()
 	{
 		return new class extends Entity

user_guide_src/source/models/entities.rst

@@ -373,3 +373,6 @@ attribute to check::
 
     $user->name = 'Fred';
     $user->hasChanged('name');      // true
+
+Or to check the whole entity for changed values omit the parameter:
+    $user->hasChanged();            // true