give / src / Framework / Support / ValueObjects / Money.php

Money.php in GiveWP – Donation Plugin and Fundraising Platform 4.16.8.1, at src/Framework/Support/ValueObjects/Money.php

183 lines 4.4 KB

Raw Download Zip

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