fortis / moneyobject

src/Money.php

<?php

namespace Money;

use Brick\Math\BigDecimal;
use Brick\Math\BigNumber;
use Brick\Math\Exception\ArithmeticException;
use Brick\Math\Exception\RoundingNecessaryException;
use Brick\Math\RoundingMode;
use Currency\Currency;
use Money\Exception\CurrencyMismatchException;

/**
 * Money class.
 *
 * Most popular currency codes for autocomplete.
 * @method static Money USD($amount, $customMinorUnit = null)
 * @method static Money EUR($amount, $customMinorUnit = null)
 * @method static Money RUB($amount, $customMinorUnit = null)
 * @method static Money JPY($amount, $customMinorUnit = null)
 * @method static Money GBP($amount, $customMinorUnit = null)
 * @method static Money CHF($amount, $customMinorUnit = null)
 * @method static Money CAD($amount, $customMinorUnit = null)
 * @method static Money AUD($amount, $customMinorUnit = null)
 * @method static Money ZAR($amount, $customMinorUnit = null)
 */
class Money implements \JsonSerializable
{
    /** @var BigDecimal */
    private $amount;

    /** @var Currency */
    private $currency;

    /**
     * @param BigNumber|number|string $amount       The amount.
     * @param string                  $currencyCode The currency code.
     * @param int|null                $customMinorUnit
     * @param int                     $rounding
     * @throws \InvalidArgumentException
     * @throws ArithmeticException
     */
    public function __construct($amount, $currencyCode, $customMinorUnit = null, $rounding = RoundingMode::UNNECESSARY)
    {
        $this->currency = Currency::create($currencyCode, $customMinorUnit);
        $this->amount = BigDecimal::of($amount)->toScale($this->currency->getMinorUnit(), $rounding);
    }

    /**
     * @param string   $amount
     * @param string   $currencyCode
     * @param int|null $customMinorUnit
     * @param int      $rounding
     * @return Money
     * @throws \InvalidArgumentException
     * @throws ArithmeticException
     */
    public static function create(
        $amount,
        $currencyCode,
        $customMinorUnit = null,
        $rounding = RoundingMode::UNNECESSARY
    ) {
        return new self($amount, $currencyCode, $customMinorUnit, $rounding);
    }

    /**
     * Convenience factory method for a Money object.
     *
     * <code>
     * $fiveDollar = Money::USD(5);
     * </code>
     *
     * @param $currencyCode
     * @param $arguments
     * @return Money
     * @throws \InvalidArgumentException
     * @throws ArithmeticException
     */
    public static function __callStatic($currencyCode, $arguments)
    {
        $amount = isset($arguments[0]) ? $arguments[0] : 0;
        $customMinorUnit = isset($arguments[1]) ? $arguments[1] : null;
        $rounding = isset($arguments[2]) ? $arguments[2] : RoundingMode::UNNECESSARY;

        return new self($amount, $currencyCode, $customMinorUnit, $rounding);
    }

    /**
     * Returns a Money with zero value, in the given Currency.
     *
     * @param Currency|string $currencyCode    A currency currency code.
     * @param int|null        $customMinorUnit Custom currency minor unit, or null to use the default.
     *
     * @return Money
     * @throws RoundingNecessaryException
     * @throws \InvalidArgumentException
     * @throws ArithmeticException
     */
    public static function zero($currencyCode, $customMinorUnit = null)
    {
        $currency = Currency::create($currencyCode, $customMinorUnit);
        $amount = BigDecimal::zero()->toScale($currency->getMinorUnit());

        return new self($amount, $currencyCode);
    }

    /**
     * @param Money $other
     * @throws CurrencyMismatchException
     */
    private function assertCurrency(Money $other)

The method assertCurrency() is not used, and could be removed.

    {
        if (false === $this->isSameCurrency($other)) {
            throw CurrencyMismatchException::createFromCurrencies($this->getCurrency(), $other->getCurrency());
        }
    }

    /**
     * Returns the amount of this Money, as a BigDecimal.
     *
     * @return BigDecimal
     */
    public function getAmount()
    {
        return $this->amount;
    }

    /**
     * Returns the Currency of this Money.
     *
     * @return Currency
     */
    public function getCurrency()
    {
        return $this->currency;
    }

    /**
     * Returns a Money whose value is the absolute value of this Money.
     *
     * @return Money
     * @throws \InvalidArgumentException
     * @throws ArithmeticException
     */
    public function abs()
    {
        return new self($this->amount->abs(), $this->currency->getCode());
    }

    /**
     * Returns a Money whose value is the negated value of this Money.
     *
     * @return Money
     * @throws \InvalidArgumentException
     * @throws ArithmeticException
     */
    public function negate()
    {
        return new self($this->amount->negated(), $this->currency->getCode());
    }

    /**
     * Returns whether this Money has zero value.
     *
     * @return bool
     */
    public function isZero()
    {
        return $this->amount->isZero();
    }

    /**
     * Returns whether this Money has a negative value.
     *
     * @return bool
     */
    public function isNegative()
    {
        return $this->amount->isNegative();
    }

    /**
     * Returns whether this Money has a negative or zero value.
     *
     * @return bool
     */
    public function isNegativeOrZero()
    {
        return $this->amount->isNegativeOrZero();
    }

    /**
     * Returns whether this Money has a positive value.
     *
     * @return bool
     */
    public function isPositive()
    {
        return $this->amount->isPositive();
    }

    /**
     * Returns whether this Money has a positive or zero value.
     *
     * @return bool
     */
    public function isPositiveOrZero()
    {
        return $this->amount->isPositiveOrZero();
    }

    /**
     * Returns a new Money object that represents
     * the multiplied value by the given factor.
     *
     * @param $that
     * @param int $rounding
     * @return Money
     */
    public function multiply($that, $rounding = RoundingMode::UNNECESSARY)
    {
        $multiplier = $that instanceof Money ? $that->getAmount() : $that;
        $amount = $this->amount->multipliedBy($multiplier);

        return new self($amount, $this->currency->getCode(), $this->getCurrency()->getMinorUnit(), $rounding);
    }

    /**
     * Returns a new Money object that represents
     * the divided value by the given factor.
     *
     * @param $that
     * @param int $rounding
     * @return Money
     */
    public function divide($that, $rounding = RoundingMode::UNNECESSARY)
    {
        $divisor = $that instanceof Money ? $that->getAmount() : $that;
        $amount = $this->amount->dividedBy($divisor, $this->getAmount()->scale(), $rounding);

        return new self($amount, $this->currency->getCode(), $this->getCurrency()->getMinorUnit(), $rounding);
    }

    /**
     * Returns a new Money object that represents
     * the sum of this and an other Money object.
     *
     * @param $that
     * @return Money
     * @throws \InvalidArgumentException
     * @throws ArithmeticException
     */
    public function plus($that)
    {
        $addend = $that instanceof Money ? $that->getAmount() : $that;
        $amount = $this->amount->plus($addend);

        return new self($amount, $this->currency->getCode(), $this->getCurrency()->getMinorUnit());
    }

    /**
     * Returns a new Money object that represents
     * the difference of this and an other Money object.
     *
     * @param $that
     * @return Money
     * @throws \InvalidArgumentException
     * @throws ArithmeticException
     */
    public function minus($that)
    {
        $subtrahend = $that instanceof Money ? $that->getAmount() : $that;
        $amount = $this->amount->minus($subtrahend);

        return new self($amount, $this->currency->getCode(), $this->getCurrency()->getMinorUnit());
    }

    /**
     * Checks whether a Money has the same Currency as this.
     *
     * @param Money $that
     *
     * @return bool
     */
    public function isSameCurrency(Money $that)
    {
        return $this->currency->is($that->currency);
    }

    /**
     * Checks whether the value represented by this object equals to the other.
     *
     * @param Money $other
     *
     * @return bool
     */
    public function equals(Money $other)
    {
        return $this->amount->isEqualTo($other->amount) && $this->isSameCurrency($other);
    }

    /**
     * Returns whether this Money is less than the given amount
     *
     * @param Money|BigNumber|number|string $that
     *
     * @return bool
     *
     * @throws ArithmeticException       If the argument is an invalid number.
     * @throws CurrencyMismatchException If the argument is a money in a different currency.
     */
    public function lessThan($that)
    {
        $amount = $that instanceof Money ? $that->getAmount() : $that;

        return $this->amount->isLessThan($amount);
    }

    /**
     * Returns whether this Money is less than or equal to the given amount.
     *
     * @param Money|BigNumber|number|string $that
     *
     * @return bool
     *
     * @throws ArithmeticException       If the argument is an invalid number.
     * @throws CurrencyMismatchException If the argument is a money in a different currency.
     */
    public function lessThanOrEqual($that)
    {
        $amount = $that instanceof Money ? $that->getAmount() : $that;

        return $this->amount->isLessThanOrEqualTo($amount);
    }

    /**
     * Returns whether this Money is greater than the given amount.
     *
     * @param Money|BigNumber|number|string $that
     *
     * @return bool
     *
     * @throws ArithmeticException       If the argument is an invalid number.
     * @throws CurrencyMismatchException If the argument is a money in a different currency.
     */
    public function greaterThan($that)
    {
        $amount = $that instanceof Money ? $that->getAmount() : $that;

        return $this->amount->isGreaterThan($amount);
    }

    /**
     * Returns whether this Money is greater than or equal to the given amount.
     *
     * @param Money|BigNumber|number|string $that
     *
     * @return bool
     *
     * @throws ArithmeticException       If the argument is an invalid number.
     * @throws CurrencyMismatchException If the argument is a money in a different currency.
     */
    public function greaterThanOrEqual($that)
    {
        $amount = $that instanceof Money ? $that->getAmount() : $that;

        return $this->amount->isGreaterThanOrEqualTo($amount);
    }

    /**
     * Formats this Money with the given NumberFormatter.
     *
     * Note that NumberFormatter internally represents values using floating point arithmetic,
     * so discrepancies can appear when formatting very large monetary values.
     *
     * @param \NumberFormatter $formatter
     *
     * @return string
     */
    public function formatWith(\NumberFormatter $formatter)
    {
        return $formatter->formatCurrency(
            (string)$this->amount,

(string)$this->amount of type string is incompatible with the type double expected by parameter $value of NumberFormatter::formatCurrency().

            (string)$this->currency
        );
    }

    /**
     * Formats this Money to the given locale.
     *
     * Note that this method uses NumberFormatter, which internally represents values using floating point arithmetic,
     * so discrepancies can appear when formatting very large monetary values.
     *
     * @param string $locale
     *
     * @return string
     */
    public function formatTo($locale)
    {
        return $this->formatWith(new \NumberFormatter($locale, \NumberFormatter::CURRENCY));
    }

    /**
     * Returns a non-localized string representation of this Money, e.g. "EUR 23.00".
     *
     * @return string
     */
    public function __toString()
    {
        return $this->currency.' '.$this->amount;
    }

    /**
     * Serialize money.
     *
     * @return array
     */
    public function jsonSerialize()
    {
        return [
            'amount' => (string)$this->amount,
            'currency' => (string)$this->currency,
        ];
    }
}