steffenbrand/curr-curr

Delivers current exchange rates for EUR provided by the ECB as PHP objects.

4.1.0 2021-11-04 13:57 UTC

Requires

• php: ^7.3 || ^8.0
• guzzlehttp/guzzle: ^6.3
• psr/simple-cache: ^1.0

Requires (Dev)

• odan/cache: ^0.1.5
• phpunit/phpunit: ^9.5

Unlicense

• Steffen Brand

• php
• money
• currency
• ECB
• try
• euro
• exchange rates
• cad
• dollar
• ron
• RUB
• ezb
• EUR
• USD
• JPY
• BGN
• CZK
• DKK
• GBP
• HUF
• PLN
• SEK
• CHF
• NOK
• HRK
• AUD
• BRL
• CNY
• HKD
• IDR
• ILS
• INR
• KRW
• MXN
• MYR
• NZD
• SGD
• THB
• ZAR

README

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
• CurrCurr on GitHub

How to install

composer require steffenbrand/curr-curr

How to use

Request exchange rate for specific currency

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

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 into the EcbClient. You just have to wrap it with a CacheConfig instance.

$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.

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.

$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));