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

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

131 lines 3.1 KB

Raw Download Zip

1	<?php
2
3	namespace Money;
4
5	/**
6	* Currency Pair holding a base, a counter currency and a conversion ratio.
7	*
8	* @author Mathias Verraes
9	*
10	* @see http://en.wikipedia.org/wiki/Currency_pair
11	*/
12	final class CurrencyPair implements \JsonSerializable
13	{
14	/**
15	* Currency to convert from.
16	*
17	* @var Currency
18	*/
19	private $baseCurrency;
20
21	/**
22	* Currency to convert to.
23	*
24	* @var Currency
25	*/
26	private $counterCurrency;
27
28	/**
29	* @var float
30	*/
31	private $conversionRatio;
32
33	/**
34	* @param float $conversionRatio
35	*
36	* @throws \InvalidArgumentException If conversion ratio is not numeric
37	*/
38	public function __construct(Currency $baseCurrency, Currency $counterCurrency, $conversionRatio)
39	{
40	if (!is_numeric($conversionRatio)) {
41	throw new \InvalidArgumentException('Conversion ratio must be numeric');
42	}
43
44	$this->counterCurrency = $counterCurrency;
45	$this->baseCurrency = $baseCurrency;
46	$this->conversionRatio = (float) $conversionRatio;
47	}
48
49	/**
50	* Creates a new Currency Pair based on "EUR/USD 1.2500" form representation.
51	*
52	* @param string $iso String representation of the form "EUR/USD 1.2500"
53	*
54	* @return CurrencyPair
55	*
56	* @throws \InvalidArgumentException Format of $iso is invalid
57	*/
58	public static function createFromIso($iso)
59	{
60	$currency = '([A-Z]{2,3})';
61	$ratio = "([0-9]*\.?[0-9]+)"; // @see http://www.regular-expressions.info/floatingpoint.html
62	$pattern = '#'.$currency.'/'.$currency.' '.$ratio.'#';
63
64	$matches = [];
65
66	if (!preg_match($pattern, $iso, $matches)) {
67	throw new \InvalidArgumentException(sprintf('Cannot create currency pair from ISO string "%s", format of string is invalid', $iso));
68	}
69
70	return new self(new Currency($matches[1]), new Currency($matches[2]), $matches[3]);
71	}
72
73	/**
74	* Returns the counter currency.
75	*
76	* @return Currency
77	*/
78	public function getCounterCurrency()
79	{
80	return $this->counterCurrency;
81	}
82
83	/**
84	* Returns the base currency.
85	*
86	* @return Currency
87	*/
88	public function getBaseCurrency()
89	{
90	return $this->baseCurrency;
91	}
92
93	/**
94	* Returns the conversion ratio.
95	*
96	* @return float
97	*/
98	public function getConversionRatio()
99	{
100	return $this->conversionRatio;
101	}
102
103	/**
104	* Checks if an other CurrencyPair has the same parameters as this.
105	*
106	* @return bool
107	*/
108	public function equals(CurrencyPair $other)
109	{
110	return
111	$this->baseCurrency->equals($other->baseCurrency)
112	&& $this->counterCurrency->equals($other->counterCurrency)
113	&& $this->conversionRatio === $other->conversionRatio
114	;
115	}
116
117	/**
118	* {@inheritdoc}
119	*
120	* @return array
121	*/
122	public function jsonSerialize()
123	{
124	return [
125	'baseCurrency' => $this->baseCurrency,
126	'counterCurrency' => $this->counterCurrency,
127	'ratio' => $this->conversionRatio,
128	];
129	}
130	}
131