Add is_zero() function.

pronamic · Mar 21, 2023 · 0ebce4a · 0ebce4a
1 parent ae4b9d1
commit 0ebce4a
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/src/Money.php b/src/Money.php
@@ -356,4 +356,15 @@ public function negative() {
 			$this->currency
 		);
 	}
+
+	/**
+	 * Checks if the value represented by this object is zero.
+	 *
+	 * @link https://github.com/moneyphp/money/blob/v4.0.1/src/Money.php#L425-L431
+	 * @link https://github.com/pronamic/wp-money/issues/7
+	 * @return bool True if zero, false otherwise.
+	 */
+	public function is_zero() {
+		return $this->amount->is_zero();
+	}
 }
diff --git a/tests/src/MoneyTest.php b/tests/src/MoneyTest.php
@@ -367,4 +367,21 @@ public function test_negative() {
 		$this->assertSame( '-149.25', $money->number_format( null, '.', '' ) );
 		$this->assertSame( '149.25', $negative->number_format( null, '.', '' ) );
 	}
+
+	/**
+	 * Test is zero.
+	 */
+	public function test_is_zero() {
+		$money = new Money( '0', 'EUR' );
+
+		$this->assertTrue( $money->is_zero() );
+
+		$money = new Money( '-0', 'EUR' );
+
+		$this->assertTrue( $money->is_zero() );
+
+		$money = new Money( '10', 'EUR' );
+
+		$this->assertFalse( $money->is_zero() );
+	}
 }