1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
namespace BenTools\Currency\Provider; |
4
|
|
|
|
5
|
|
|
use BenTools\Currency\Model\CurrencyInterface; |
6
|
|
|
use BenTools\Currency\Model\ExchangeRateFactoryInterface; |
7
|
|
|
use BenTools\Currency\Model\ExchangeRateInterface; |
8
|
|
|
use BenTools\Currency\Model\ExchangeRateNotFoundException; |
9
|
|
|
use BenTools\Currency\Model\NativeExchangeRateFactory; |
10
|
|
|
use DateTime; |
11
|
|
|
use DateTimeImmutable; |
12
|
|
|
use DateTimeInterface; |
13
|
|
|
use DateTimeZone; |
14
|
|
|
use Http\Client\HttpClient; |
15
|
|
|
use Http\Discovery\HttpClientDiscovery; |
16
|
|
|
use Http\Discovery\MessageFactoryDiscovery; |
17
|
|
|
use Http\Message\RequestFactory; |
18
|
|
|
use Psr\SimpleCache\CacheInterface; |
19
|
|
|
|
20
|
|
|
final class OpenExchangeRatesProvider implements ExchangeRateProviderInterface |
21
|
|
|
{ |
22
|
|
|
/** |
23
|
|
|
* @var string |
24
|
|
|
*/ |
25
|
|
|
private $appId; |
26
|
|
|
|
27
|
|
|
/** |
28
|
|
|
* @var HttpClient|null |
29
|
|
|
*/ |
30
|
|
|
private $client; |
31
|
|
|
|
32
|
|
|
/** |
33
|
|
|
* @var RequestFactory|null |
34
|
|
|
*/ |
35
|
|
|
private $requestFactory; |
36
|
|
|
|
37
|
|
|
/** |
38
|
|
|
* @var ExchangeRateFactoryInterface|null |
39
|
|
|
*/ |
40
|
|
|
private $exchangeRateFactory; |
41
|
|
|
|
42
|
|
|
/** |
43
|
|
|
* OpenExchangeRatesProvider constructor. |
44
|
|
|
* @param string $appId |
45
|
|
|
* @param HttpClient|null $client |
46
|
|
|
* @param RequestFactory|null $requestFactory |
47
|
|
|
* @param ExchangeRateFactoryInterface|null $exchangeRateFactory |
48
|
|
|
* @throws \Http\Discovery\Exception\NotFoundException |
49
|
|
|
*/ |
50
|
|
|
public function __construct( |
51
|
|
|
string $appId, |
52
|
|
|
HttpClient $client = null, |
53
|
|
|
RequestFactory $requestFactory = null, |
54
|
|
|
ExchangeRateFactoryInterface $exchangeRateFactory = null |
55
|
|
|
) { |
56
|
|
|
$this->appId = $appId; |
57
|
|
|
$this->client = $client ?? HttpClientDiscovery::find(); |
58
|
|
|
$this->requestFactory = $requestFactory ?? MessageFactoryDiscovery::find(); |
59
|
|
|
$this->exchangeRateFactory = $exchangeRateFactory ?? new NativeExchangeRateFactory(); |
60
|
|
|
} |
61
|
|
|
|
62
|
|
|
/** |
63
|
|
|
* @inheritDoc |
64
|
|
|
*/ |
65
|
|
|
public function getExchangeRate(CurrencyInterface $sourceCurrency, CurrencyInterface $targetCurrency, DateTimeInterface $date = null): ExchangeRateInterface |
66
|
|
|
{ |
67
|
|
|
if (null === $date) { |
68
|
|
|
$date = new DateTimeImmutable('now', new DateTimeZone('UTC')); |
69
|
|
|
} |
70
|
|
|
|
71
|
|
|
if ($date instanceof DateTime) { |
72
|
|
|
$date = DateTimeImmutable::createFromMutable($date)->setTimezone(new DateTimeZone('UTC')); |
73
|
|
|
} |
74
|
|
|
|
75
|
|
|
if (!in_array('USD', [$sourceCurrency->getCode(), $targetCurrency->getCode()])) { |
76
|
|
|
throw new ExchangeRateNotFoundException($sourceCurrency, $targetCurrency, "OpenExchangeRates Free plan only provide USD-based currency conversions."); |
77
|
|
|
} |
78
|
|
|
|
79
|
|
|
// Same currencies |
80
|
|
|
if ($sourceCurrency->getCode() === $targetCurrency->getCode()) { |
81
|
|
|
return $this->exchangeRateFactory->create($sourceCurrency, $targetCurrency, 1); |
82
|
|
|
} |
83
|
|
|
|
84
|
|
|
// Invert currencies |
85
|
|
|
if ('USD' === $targetCurrency->getCode()) { // OpenExchangeRates only provide USD -> * |
86
|
|
|
$revertExchangeRate = $this->getExchangeRate($targetCurrency, $sourceCurrency, $date); |
|
|
|
|
87
|
|
|
return $this->exchangeRateFactory->create($sourceCurrency, $targetCurrency, 1 / $revertExchangeRate->getRatio()); |
88
|
|
|
} |
89
|
|
|
|
90
|
|
|
$url = sprintf('https://openexchangerates.org/api/historical/%s.json?app_id=%s', $date->format('Y-m-d'), $this->appId); |
|
|
|
|
91
|
|
|
$response = $this->client->sendRequest($this->requestFactory->createRequest('GET', $url)); |
92
|
|
|
$json = json_decode((string) $response->getBody(), true); |
93
|
|
|
if (isset($json['rates'][$targetCurrency->getCode()])) { |
94
|
|
|
return $this->exchangeRateFactory->create($sourceCurrency, $targetCurrency, $json['rates'][$targetCurrency->getCode()]); |
95
|
|
|
} |
96
|
|
|
|
97
|
|
|
throw new ExchangeRateNotFoundException($sourceCurrency, $targetCurrency); |
98
|
|
|
} |
99
|
|
|
} |
100
|
|
|
|
This check looks for type mismatches where the missing type is
false
. This is usually indicative of an error condtion.Consider the follow example
This function either returns a new
DateTime
object or false, if there was an error. This is a typical pattern in PHP programming to show that an error has occurred without raising an exception. The calling code should check for this returnedfalse
before passing on the value to another function or method that may not be able to handle afalse
.