Money.php

<?php

declare(strict_types=1);

namespace SonsOfPHP\Component\Money;

use JsonSerializable;
use SonsOfPHP\Component\Money\Operator\Money\AddMoneyOperator;
use SonsOfPHP\Component\Money\Operator\Money\DivideMoneyOperator;
use SonsOfPHP\Component\Money\Operator\Money\MultiplyMoneyOperator;
use SonsOfPHP\Component\Money\Operator\Money\SubtractMoneyOperator;
use SonsOfPHP\Component\Money\Query\Money\IsEqualToMoneyQuery;
use SonsOfPHP\Component\Money\Query\Money\IsGreaterThanMoneyQuery;
use SonsOfPHP\Component\Money\Query\Money\IsGreaterThanOrEqualToMoneyQuery;
use SonsOfPHP\Component\Money\Query\Money\IsLessThanMoneyQuery;
use SonsOfPHP\Component\Money\Query\Money\IsLessThanOrEqualToMoneyQuery;
use SonsOfPHP\Component\Money\Query\Money\IsNegativeMoneyQuery;
use SonsOfPHP\Component\Money\Query\Money\IsPositiveMoneyQuery;
use SonsOfPHP\Component\Money\Query\Money\IsZeroMoneyQuery;
use SonsOfPHP\Contract\Money\AmountInterface;
use SonsOfPHP\Contract\Money\CurrencyInterface;
use SonsOfPHP\Contract\Money\MoneyInterface;
use SonsOfPHP\Contract\Money\MoneyOperatorInterface;
use SonsOfPHP\Contract\Money\MoneyQueryInterface;
use Stringable;

/**
 * @author Joshua Estes <joshua@sonsofphp.com>
 */
final class Money implements MoneyInterface, JsonSerializable, Stringable
{
    private readonly AmountInterface $amount;

    public function __construct($amount, private readonly CurrencyInterface $currency)
    {
        if (!$amount instanceof AmountInterface) {
            $amount = new Amount($amount);
        }

        $this->amount   = $amount;
    }

    public function __toString(): string
    {
        return $this->amount->toString();
    }

    /**
     * Example: Money::USD(100);.
     */
    public static function __callStatic(string $method, array $args)
    {
        return new self($args[0], new Currency($method));
    }

    /**
     * @return int
     *             -1 = this less than that
     *             0 = this equals that
     *             1 = this greater than that
     */
    public function compare(MoneyInterface $money): int
    {
        if ($this->isLessThan($money)) {
            return -1;
        }

        if ($this->isGreaterThan($money)) {
            return 1;
        }

        return 0;
    }

    public function with(MoneyOperatorInterface $operator): MoneyInterface
    {
        return $operator->apply($this);
    }

    public function query(MoneyQueryInterface $query)
    {
        return $query->queryFrom($this);
    }

    public function getAmount(): AmountInterface
    {
        return $this->amount;
    }

    public function getCurrency(): CurrencyInterface
    {
        return $this->currency;
    }

    public function isEqualTo(MoneyInterface $money): bool
    {
        return $this->query(new IsEqualToMoneyQuery($money));
    }

    public function isGreaterThan(MoneyInterface $money): bool
    {
        return $this->query(new IsGreaterThanMoneyQuery($money));
    }

    public function isGreaterThanOrEqualTo(MoneyInterface $money): bool
    {
        return $this->query(new IsGreaterThanOrEqualToMoneyQuery($money));
    }

    public function isLessThan(MoneyInterface $money): bool
    {
        return $this->query(new IsLessThanMoneyQuery($money));
    }

    public function isLessThanOrEqualTo(MoneyInterface $money): bool
    {
        return $this->query(new IsLessThanOrEqualToMoneyQuery($money));
    }

    public function isNegative(): bool
    {
        return $this->query(new IsNegativeMoneyQuery());
    }

    public function isPositive(): bool
    {
        return $this->query(new IsPositiveMoneyQuery());
    }

    public function isZero(): bool
    {
        return $this->query(new IsZeroMoneyQuery());
    }

    public function add(MoneyInterface $money): MoneyInterface
    {
        return $this->with(new AddMoneyOperator($money));
    }

    public function subtract(MoneyInterface $money): MoneyInterface
    {
        return $this->with(new SubtractMoneyOperator($money));
    }

    public function multiply($multiplier): MoneyInterface
    {
        return $this->with(new MultiplyMoneyOperator($multiplier));
    }

    public function divide($divisor): MoneyInterface
    {
        return $this->with(new DivideMoneyOperator($divisor));
    }

    public function jsonSerialize(): array
    {
        return [
            'amount' => $this->getAmount()->toInt(),
            'currency' => $this->getCurrency()->getCurrencyCode(),
        ];
    }
}