Money.php
160 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\Framework\Support\ValueObjects; |
| 4 | |
| 5 | use Give\Framework\Exceptions\Primitives\InvalidArgumentException; |
| 6 | use Give\Framework\Support\Currency; |
| 7 | use Money\Currency as VendorCurrency; |
| 8 | use Money\Money as VendorMoney; |
| 9 | |
| 10 | /** |
| 11 | * A decorator class for the vendor Money class which adds additional formatting and other convenience methods. Try and |
| 12 | * keep the vendor Money logic in the Currency facade. |
| 13 | * |
| 14 | * @since 2.20.0 |
| 15 | * |
| 16 | * @method bool equals(Money $money ) |
| 17 | * @method Money subtract(Money $money) |
| 18 | * @method Money add(Money $money) |
| 19 | * |
| 20 | * @mixin VendorMoney |
| 21 | */ |
| 22 | class Money |
| 23 | { |
| 24 | /** |
| 25 | * @var VendorMoney |
| 26 | */ |
| 27 | private $amount; |
| 28 | |
| 29 | /** |
| 30 | * @since 2.20.0 |
| 31 | * |
| 32 | * @param string|int $amount |
| 33 | * @param string|VendorCurrency $currency |
| 34 | */ |
| 35 | public function __construct($amount, $currency) |
| 36 | { |
| 37 | if (!$currency instanceof VendorCurrency) { |
| 38 | $currency = new VendorCurrency($currency); |
| 39 | } |
| 40 | |
| 41 | $this->amount = new VendorMoney($amount, $currency); |
| 42 | } |
| 43 | |
| 44 | /** |
| 45 | * Returns the amount in the smallest unit of the currency. |
| 46 | * |
| 47 | * @since 2.20.0 |
| 48 | * |
| 49 | * @return string |
| 50 | */ |
| 51 | public function formatToMinorAmount() |
| 52 | { |
| 53 | return $this->amount->getAmount(); |
| 54 | } |
| 55 | |
| 56 | /** |
| 57 | * Returns a new instance converted to the system base currency |
| 58 | * |
| 59 | * @since 2.20.0 |
| 60 | * |
| 61 | * @param $exchangeRate |
| 62 | * |
| 63 | * @return Money |
| 64 | */ |
| 65 | public function inBaseCurrency($exchangeRate = 1) |
| 66 | { |
| 67 | return self::fromMoney(Currency::convertToBaseCurrency($this->amount, $exchangeRate)); |
| 68 | } |
| 69 | |
| 70 | /** |
| 71 | * Returns the amount in a decimal format, not including any currency symbols: |
| 72 | * - $1,500.25 -> 1500.25 |
| 73 | * |
| 74 | * @since 2.20.0 |
| 75 | * |
| 76 | * @return string |
| 77 | */ |
| 78 | public function formatToDecimal() |
| 79 | { |
| 80 | return Currency::formatToDecimal($this->amount); |
| 81 | } |
| 82 | |
| 83 | /** |
| 84 | * Formats the amount to a currency format, including currency symbols, in the given locale. |
| 85 | * |
| 86 | * @since 2.20.0 |
| 87 | * |
| 88 | * @param string|null $locale |
| 89 | * |
| 90 | * @return string |
| 91 | */ |
| 92 | public function formatToLocale($locale = null) |
| 93 | { |
| 94 | return Currency::formatToLocale($this->amount, $locale); |
| 95 | } |
| 96 | |
| 97 | /** |
| 98 | * Passes all unknown method calls to the underlying vendor Money instance. |
| 99 | * Any instance of this class in arguments will be converted to the underlying vendor Money instance. |
| 100 | * If the returned value is an instance of the vendor Money class, it will be converted to an instance of this class. |
| 101 | * |
| 102 | * @since 2.20.0 |
| 103 | * |
| 104 | * @param $name |
| 105 | * @param $arguments |
| 106 | * |
| 107 | * @return mixed |
| 108 | */ |
| 109 | public function __call($name, $arguments) |
| 110 | { |
| 111 | if (!method_exists($this->amount, $name)) { |
| 112 | throw new InvalidArgumentException("Invalid method: $name"); |
| 113 | } |
| 114 | |
| 115 | if (!empty($arguments)) { |
| 116 | $arguments = array_map(static function ($argument) { |
| 117 | if ($argument instanceof Money) { |
| 118 | return $argument->amount; |
| 119 | } |
| 120 | |
| 121 | return $argument; |
| 122 | }, $arguments); |
| 123 | } |
| 124 | |
| 125 | $value = $this->amount->$name(...$arguments); |
| 126 | |
| 127 | if ($value instanceof VendorMoney) { |
| 128 | return self::fromMoney($value); |
| 129 | } |
| 130 | |
| 131 | return $value; |
| 132 | } |
| 133 | |
| 134 | /** |
| 135 | * Returns a new, immutable instance from a vendor Money instance |
| 136 | * |
| 137 | * @since 2.20.0 |
| 138 | * |
| 139 | * @param VendorMoney $money |
| 140 | * |
| 141 | * @return Money |
| 142 | */ |
| 143 | public static function fromMoney(VendorMoney $money) |
| 144 | { |
| 145 | return new self($money->getAmount(), $money->getCurrency()); |
| 146 | } |
| 147 | |
| 148 | /** |
| 149 | * Creates a new Money instance from a decimal amount |
| 150 | * |
| 151 | * @since 2.20.0 |
| 152 | * |
| 153 | * @param string|float|int $amount |
| 154 | */ |
| 155 | public static function fromDecimal($amount, string $currency): Money |
| 156 | { |
| 157 | return self::fromMoney(Currency::parseFromDecimal($amount, $currency)); |
| 158 | } |
| 159 | } |
| 160 |