Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/steffenbrand/curr-curr
Delivers current exchange rates for EUR provided by the ECB under https://www.ecb.europa.eu/stats/eurofxref/eurofxref-daily.xml as PHP objects.
https://github.com/steffenbrand/curr-curr
currency currency-exchange-rates exchange-rate
Last synced: 11 days ago
JSON representation
Delivers current exchange rates for EUR provided by the ECB under https://www.ecb.europa.eu/stats/eurofxref/eurofxref-daily.xml as PHP objects.
- Host: GitHub
- URL: https://github.com/steffenbrand/curr-curr
- Owner: steffenbrand
- License: unlicense
- Created: 2016-09-18T05:56:25.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-11-04T13:59:34.000Z (over 3 years ago)
- Last Synced: 2024-04-24T18:41:51.974Z (10 months ago)
- Topics: currency, currency-exchange-rates, exchange-rate
- Language: PHP
- Homepage: https://github.com/steffenbrand/curr-curr
- Size: 167 KB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# CurrCurr - Current Currency (Exchange Rates)
[](https://travis-ci.org/steffenbrand/curr-curr)
[](https://codecov.io/gh/steffenbrand/curr-curr)
[](https://scrutinizer-ci.com/g/steffenbrand/curr-curr/?branch=master)
[](https://packagist.org/packages/steffenbrand/curr-curr)
[](//packagist.org/packages/steffenbrand/curr-curr)
[](https://packagist.org/packages/steffenbrand/curr-curr)
[](https://github.com/steffenbrand/curr-curr/blob/master/LICENSE.md)
[](https://github.com/steffenbrand/curr-curr/blob/master/composer.lock)
Delivers current exchange rates for EUR provided by the ECB under https://www.ecb.europa.eu/stats/eurofxref/eurofxref-daily.xml as PHP objects.
* [CurrCurr on Packagist](https://packagist.org/packages/steffenbrand/curr-curr)
* [CurrCurr on GitHub](https://github.com/steffenbrand/curr-curr)
## How to install
```
composer require steffenbrand/curr-curr
```
## How to use
### Request exchange rate for specific currency
```php
try {
$cc = new CurrCurr();
$exchangeRate = $cc->getExchangeRateByCurrency(Currency::USD);
$exchangeRate->getDate();
$exchangeRate->getCurrency();
$exchangeRate->getRate();
} catch (ExchangeRatesRequestFailedException $e) {
// webservice might not be present
} catch (ExchangeRatesMappingFailedException $e) {
// webservice might not deliver what we expect
} catch (CurrencyNotSupportedException $e) {
// requested currency might not be provided
}
```
### Request all available exchange rates
```php
try {
$cc = new CurrCurr();
$exchangeRates = $cc->getExchangeRates();
$exchangeRates[Currency::USD]->getDate();
$exchangeRates[Currency::USD]->getCurrency();
$exchangeRates[Currency::USD]->getRate();
foreach ($exchangeRates as $exchangeRate) {
$exchangeRate->getDate();
$exchangeRate->getCurrency();
$exchangeRate->getRate();
}
} catch (ExchangeRatesRequestFailedException $e) {
// webservice might not be present
} catch (ExchangeRatesMappingFailedException $e) {
// webservice might not deliver what we expect
}
```
### Using PSR-16 SimpleCache
CurrCurr does not provide its own SimpleCache implementation, however it does give you the possibility
to inject any [PSR-16 compliant implementation](https://packagist.org/providers/psr/simple-cache-implementation) into the EcbClient.
You just have to wrap it with a CacheConfig instance.
```php
$cc = new CurrCurr(
new EcbClient(
EcbClient::DEFAULT_EXCHANGE_RATES_URL,
new CacheConfig(
new OpCache(sys_get_temp_dir() . '/cache')
// Any PSR-16 compliant implementation
// This example uses odan/cache
)
)
);
```
You can provide your own key and time to live.
```php
new CacheConfig(
new OpCache(sys_get_temp_dir() . '/cache')
CacheConfig::CACHE_UNTIL_MIDNIGHT, // time to live in seconds
CacheConfig::DEFAULT_CACHE_KEY // key used for caching
);
```
### Mocking webservice response for Unit Testing your own project
CurrCurr allows you to inject your own implementation of the EcbClientInterface.
But you can also use the provided EcbClientMock, which allows you to simulate 3 different responses.
```php
$cc1 = new CurrCurr(new EcbClientMock(EcbClientMock::VALID_RESPONSE));
$cc2 = new CurrCurr(new EcbClientMock(EcbClientMock::USD_MISSING_RESPONSE));
$cc3 = new CurrCurr(new EcbClientMock(EcbClientMock::DATE_MISSING_RESPONSE));
```