improved code completion for class \CakeDC\Money\Money

CakeDC · Feb 29, 2024 · e0d8680 · e0d8680
1 parent abb1a11
commit e0d8680
Showing 1 changed file with 44 additions and 0 deletions.
diff --git a/src/Money.php b/src/Money.php
@@ -19,10 +19,54 @@
  *
  * This class encapsulates MoneyPHP\Money and extends features
  *
+ * @method bool isSameCurrency(\CakeDC\Money\Money $other) See \Money\Money::isSameCurrency()
+ * @method bool equals(\CakeDC\Money\Money $other) See \Money\Money::equals()
+ * @method int compare(\CakeDC\Money\Money $other) See \Money\Money::compare()
+ * @method bool greaterThan(\CakeDC\Money\Money $other) See \Money\Money::greaterThan()
+ * @method bool greaterThanOrEqual(\CakeDC\Money\Money $other) See \Money\Money::greaterThanOrEqual()
+ * @method bool lessThan(\CakeDC\Money\Money $other) See \Money\Money::lessThan()
+ * @method bool lessThanOrEqual(\CakeDC\Money\Money $other) See \Money\Money::lessThanOrEqual()
+ * @method string getAmount() See \Money\Money::getAmount()
+ * @method \Money\Currency getCurrency() See \Money\Money::getCurrency()
+ * @method \CakeDC\Money\Money add(\CakeDC\Money\Money ...$addends) See \Money\Money::add()
+ * @method \CakeDC\Money\Money subtract(\CakeDC\Money\Money ...$subtrahends) See \Money\Money::subtract()
+ * @method \CakeDC\Money\Money multiply($multiplier, $roundingMode = \CakeDC\Money\Money::ROUND_HALF_UP) See \Money\Money::multiply()
+ * @method \CakeDC\Money\Money divide($divisor, $roundingMode = \CakeDC\Money\Money::ROUND_HALF_UP) See \Money\Money::divide()
+ * @method \CakeDC\Money\Money mod(\CakeDC\Money\Money $divisor) See \Money\Money::mod()
+ * @method \CakeDC\Money\Money[] allocate(array $ratios) See \Money\Money::allocate()
+ * @method \CakeDC\Money\Money[] allocateTo($n) See \Money\Money::allocateTo()
+ * @method string ratioOf(Money $money) See \Money\Money::ratioOf()
+ * @method \CakeDC\Money\Money absolute() See \Money\Money::absolute()
+ * @method \CakeDC\Money\Money negative() See \Money\Money::negative()
+ * @method bool isZero() See \Money\Money::isZero()
+ * @method bool isPositive() See \Money\Money::isPositive()
+ * @method bool isNegative() See \Money\Money::isNegative()
+ * @method bool jsonSerialize() See \Money\Money::jsonSerialize()
+ * @method static \CakeDC\Money\Money min(\CakeDC\Money\Money $first, \CakeDC\Money\Money ...$collection) See \Money\Money::min()
+ * @method static \CakeDC\Money\Money max(\CakeDC\Money\Money $first, \CakeDC\Money\Money ...$collection) See \Money\Money::max()
+ * @method static \CakeDC\Money\Money sum(\CakeDC\Money\Money $first, \CakeDC\Money\Money ...$collection) See \Money\Money::sum()
+ * @method static \CakeDC\Money\Money avg(\CakeDC\Money\Money $first, \CakeDC\Money\Money ...$collection) See \Money\Money::avg()
+ * @method static void registerCalculator(string $calculator) See \Money\Money::registerCalculator()
+ * @see \Money\Money
  * @package CakeDC\Money
  */
 class Money
 {
+    const ROUND_HALF_UP = PHP_ROUND_HALF_UP;
+
+    const ROUND_HALF_DOWN = PHP_ROUND_HALF_DOWN;
+
+    const ROUND_HALF_EVEN = PHP_ROUND_HALF_EVEN;
+
+    const ROUND_HALF_ODD = PHP_ROUND_HALF_ODD;
+
+    const ROUND_UP = 5;
+
+    const ROUND_DOWN = 6;
+
+    const ROUND_HALF_POSITIVE_INFINITY = 7;
+
+    const ROUND_HALF_NEGATIVE_INFINITY = 8;
 
     /**
      * @var MoneyPHP