give / vendor / moneyphp / money / src / Number.php

Number.php in GiveWP – Donation Plugin and Fundraising Platform 4.15.0, at vendor/moneyphp/money/src/Number.php

332 lines 8.1 KB

Raw Download Zip

1	<?php
2
3	namespace Money;
4
5	/**
6	* Represents a numeric value.
7	*
8	* @author Frederik Bosch <f.bosch@genkgo.nl>
9	*/
10	final class Number
11	{
12	/**
13	* @var string
14	*/
15	private $integerPart;
16
17	/**
18	* @var string
19	*/
20	private $fractionalPart;
21
22	/**
23	* @var array
24	*/
25	private static $numbers = [0 => 1, 1 => 1, 2 => 1, 3 => 1, 4 => 1, 5 => 1, 6 => 1, 7 => 1, 8 => 1, 9 => 1];
26
27	/**
28	* @param string $integerPart
29	* @param string $fractionalPart
30	*/
31	public function __construct($integerPart, $fractionalPart = '')
32	{
33	if ('' === $integerPart && '' === $fractionalPart) {
34	throw new \InvalidArgumentException('Empty number is invalid');
35	}
36
37	$this->integerPart = $this->parseIntegerPart((string) $integerPart);
38	$this->fractionalPart = $this->parseFractionalPart((string) $fractionalPart);
39	}
40
41	/**
42	* @param $number
43	*
44	* @return self
45	*/
46	public static function fromString($number)
47	{
48	$decimalSeparatorPosition = strpos($number, '.');
49	if ($decimalSeparatorPosition === false) {
50	return new self($number, '');
51	}
52
53	return new self(
54	substr($number, 0, $decimalSeparatorPosition),
55	rtrim(substr($number, $decimalSeparatorPosition + 1), '0')
56	);
57	}
58
59	/**
60	* @param float $number
61	*
62	* @return self
63	*/
64	public static function fromFloat($number)
65	{
66	if (is_float($number) === false) {
67	throw new \InvalidArgumentException('Floating point value expected');
68	}
69
70	return self::fromString(sprintf('%.14F', $number));
71	}
72
73	/**
74	* @param float\|int\|string $number
75	*
76	* @return self
77	*/
78	public static function fromNumber($number)
79	{
80	if (is_float($number)) {
81	return self::fromString(sprintf('%.14F', $number));
82	}
83
84	if (is_int($number)) {
85	return new self($number);
86	}
87
88	if (is_string($number)) {
89	return self::fromString($number);
90	}
91
92	throw new \InvalidArgumentException('Valid numeric value expected');
93	}
94
95	/**
96	* @return bool
97	*/
98	public function isDecimal()
99	{
100	return $this->fractionalPart !== '';
101	}
102
103	/**
104	* @return bool
105	*/
106	public function isInteger()
107	{
108	return $this->fractionalPart === '';
109	}
110
111	/**
112	* @return bool
113	*/
114	public function isHalf()
115	{
116	return $this->fractionalPart === '5';
117	}
118
119	/**
120	* @return bool
121	*/
122	public function isCurrentEven()
123	{
124	$lastIntegerPartNumber = $this->integerPart[strlen($this->integerPart) - 1];
125
126	return $lastIntegerPartNumber % 2 === 0;
127	}
128
129	/**
130	* @return bool
131	*/
132	public function isCloserToNext()
133	{
134	if ($this->fractionalPart === '') {
135	return false;
136	}
137
138	return $this->fractionalPart[0] >= 5;
139	}
140
141	/**
142	* @return string
143	*/
144	public function __toString()
145	{
146	if ($this->fractionalPart === '') {
147	return $this->integerPart;
148	}
149
150	return $this->integerPart.'.'.$this->fractionalPart;
151	}
152
153	/**
154	* @return bool
155	*/
156	public function isNegative()
157	{
158	return $this->integerPart[0] === '-';
159	}
160
161	/**
162	* @return string
163	*/
164	public function getIntegerPart()
165	{
166	return $this->integerPart;
167	}
168
169	/**
170	* @return string
171	*/
172	public function getFractionalPart()
173	{
174	return $this->fractionalPart;
175	}
176
177	/**
178	* @return string
179	*/
180	public function getIntegerRoundingMultiplier()
181	{
182	if ($this->integerPart[0] === '-') {
183	return '-1';
184	}
185
186	return '1';
187	}
188
189	/**
190	* @param int $number
191	*
192	* @return self
193	*/
194	public function base10($number)
195	{
196	if (!is_int($number)) {
197	throw new \InvalidArgumentException('Expecting integer');
198	}
199
200	if ($this->integerPart === '0' && !$this->fractionalPart) {
201	return $this;
202	}
203
204	$sign = '';
205	$integerPart = $this->integerPart;
206
207	if ($integerPart[0] === '-') {
208	$sign = '-';
209	$integerPart = substr($integerPart, 1);
210	}
211
212	if ($number >= 0) {
213	$integerPart = ltrim($integerPart, '0');
214	$lengthIntegerPart = strlen($integerPart);
215	$integers = $lengthIntegerPart - min($number, $lengthIntegerPart);
216	$zeroPad = $number - min($number, $lengthIntegerPart);
217
218	return new self(
219	$sign.substr($integerPart, 0, $integers),
220	rtrim(str_pad('', $zeroPad, '0').substr($integerPart, $integers).$this->fractionalPart, '0')
221	);
222	}
223
224	$number = abs($number);
225	$lengthFractionalPart = strlen($this->fractionalPart);
226	$fractions = $lengthFractionalPart - min($number, $lengthFractionalPart);
227	$zeroPad = $number - min($number, $lengthFractionalPart);
228
229	return new self(
230	$sign.ltrim($integerPart.substr($this->fractionalPart, 0, $lengthFractionalPart - $fractions).str_pad('', $zeroPad, '0'), '0'),
231	substr($this->fractionalPart, $lengthFractionalPart - $fractions)
232	);
233	}
234
235	/**
236	* @param string $number
237	*
238	* @return string
239	*/
240	private static function parseIntegerPart($number)
241	{
242	if ('' === $number \|\| '0' === $number) {
243	return '0';
244	}
245
246	if ('-' === $number) {
247	return '-0';
248	}
249
250	$nonZero = false;
251
252	for ($position = 0, $characters = strlen($number); $position < $characters; ++$position) {
253	$digit = $number[$position];
254
255	if (!isset(static::$numbers[$digit]) && !(0 === $position && '-' === $digit)) {
256	throw new \InvalidArgumentException(sprintf('Invalid integer part %1$s. Invalid digit %2$s found', $number, $digit));
257	}
258
259	if (false === $nonZero && '0' === $digit) {
260	throw new \InvalidArgumentException('Leading zeros are not allowed');
261	}
262
263	$nonZero = true;
264	}
265
266	return $number;
267	}
268
269	/**
270	* @param string $number
271	*
272	* @return string
273	*/
274	private static function parseFractionalPart($number)
275	{
276	if ('' === $number) {
277	return $number;
278	}
279
280	for ($position = 0, $characters = strlen($number); $position < $characters; ++$position) {
281	$digit = $number[$position];
282	if (!isset(static::$numbers[$digit])) {
283	throw new \InvalidArgumentException(sprintf('Invalid fractional part %1$s. Invalid digit %2$s found', $number, $digit));
284	}
285	}
286
287	return $number;
288	}
289
290	/**
291	* @param string $moneyValue
292	* @param int $targetDigits
293	* @param int $havingDigits
294	*
295	* @return string
296	*/
297	public static function roundMoneyValue($moneyValue, $targetDigits, $havingDigits)
298	{
299	$valueLength = strlen($moneyValue);
300	$shouldRound = $targetDigits < $havingDigits && $valueLength - $havingDigits + $targetDigits > 0;
301
302	if ($shouldRound && $moneyValue[$valueLength - $havingDigits + $targetDigits] >= 5) {
303	$position = $valueLength - $havingDigits + $targetDigits;
304	$addend = 1;
305
306	while ($position > 0) {
307	$newValue = (string) ((int) $moneyValue[$position - 1] + $addend);
308
309	if ($newValue >= 10) {
310	$moneyValue[$position - 1] = $newValue[1];
311	$addend = $newValue[0];
312	--$position;
313	if ($position === 0) {
314	$moneyValue = $addend.$moneyValue;
315	}
316	} else {
317	if ($moneyValue[$position - 1] === '-') {
318	$moneyValue[$position - 1] = $newValue[0];
319	$moneyValue = '-'.$moneyValue;
320	} else {
321	$moneyValue[$position - 1] = $newValue[0];
322	}
323
324	break;
325	}
326	}
327	}
328
329	return $moneyValue;
330	}
331	}
332