give / src / ValueObjects / Money.php

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

132 lines 3.2 KB

Raw Download Zip

1	<?php
2
3	namespace Give\ValueObjects;
4
5	/**
6	* Class Money
7	*
8	* @deprecated @since 2.20.0 Use Give\Framework\Support\ValueObjects\Money in framework instead
9	*
10	* @since 2.9.0
11	* @since 2.11.0 Refactored to make the minor amount the base.
12	*/
13	class Money
14	{
15	/**
16	* The amount in smallest unit of currency.
17	* @var int
18	*/
19	protected $minorAmount;
20
21	/**
22	* @var array
23	*/
24	protected $currencyData;
25
26	/**
27	* Money constructor.
28	*
29	* @param int $minorAmount
30	* @param array $currencyData
31	*/
32	public function __construct($minorAmount, $currencyData)
33	{
34	$this->minorAmount = $minorAmount;
35	$this->currencyData = $currencyData;
36	}
37
38	/**
39	* Get amount in smallest unit of currency.
40	*
41	* @sicne 2.9.0
42	* @since 2.11.0 Round minor amount to account for floating point precision.
43	*
44	* @return int
45	*/
46	public function getMinorAmount()
47	{
48	return $this->minorAmount;
49	}
50
51	/**
52	* Get amount in smallest unit of currency.
53	*
54	* @sicne 2.9.0
55	*
56	* @return string
57	*/
58	public function getAmount()
59	{
60	if ($this->currencyData['setting']['number_decimals']) {
61	return $this->minorAmount / (10 ** $this->currencyData['setting']['number_decimals']);
62	}
63
64	return $this->minorAmount;
65	}
66
67	// Static Methods and Factories
68
69	/**
70	* @since 2.9.0
71	* @since 2.11.0 Converts the amount to a minor amount when creating an instance.
72	*
73	* @param int\|string $amount Amount value without currency formatting
74	* @param string $currency
75	*
76	* @return Money
77	*/
78	public static function of($amount, $currency)
79	{
80	$currencyData = self::getCurrencyData($currency);
81
82	/**
83	* When working with float values, be careful when casting to an integer.
84	* Due to "floating point precision", the output may not match the expected value.
85	*
86	* @link https://www.php.net/manual/en/language.types.float.php
87	* This can lead to confusing results:
88	* for example, floor((0.1+0.7)*10) will usually return 7 instead of the expected 8,
89	* since the internal representation will be something like 7.9999999999999991118....
90	*/
91	$amount = absint(
92	round($amount * (10 ** $currencyData['setting']['number_decimals']))
93	);
94
95	return new static($amount, $currencyData);
96	}
97
98	/**
99	* @since 2.9.0
100	*
101	* @param int\|string $minorAmount
102	* @param string $currency
103	*
104	* @return Money
105	*/
106	public static function ofMinor($minorAmount, $currency)
107	{
108	return new static($minorAmount, self::getCurrencyData($currency));
109	}
110
111	/**
112	* Retrieves the currency data for a given currency with some optimizations to avoid loading all the currencies more
113	* than once.
114	*
115	* @since 2.9.0
116	*
117	* @param $currency
118	*
119	* @return array
120	*/
121	private static function getCurrencyData($currency)
122	{
123	static $currenciesData = null;
124
125	if ($currenciesData === null) {
126	$currenciesData = give_get_currencies('all');
127	}
128
129	return $currenciesData[$currency];
130	}
131	}
132