A thin wrapper for Fixer.io, a service for foreign exchange rates and currency conversion. It provides a few methods to easily construct the url, makes the api call and gives back the response.
- Add the package to your composer.json file and run
composer update:
{
"require": {
"fadion/fixerio": "dev-master"
}
}Laravel 5 users can use the Facade for even easier access.
- Add
Fadion\Fixerio\ExchangeServiceProvider::classto yourconfig/app.phpfile, inside theprovidersarray. - Add a new alias:
'Exchange' => Fadion\Fixerio\Facades\Exchange::classto yourconfig/app.phpfile, inside thealiasesarray.
Let's get the rates of EUR and GBP with USD as the base currency:
use Fadion\Fixerio\Exchange;
use Fadion\Fixerio\Currency;
$exchange = new Exchange();
$exchange->base(Currency::USD);
$exchange->symbols(Currency::EUR, Currency::GBP);
$rates = $exchange->get();By default, the base currency is EUR, so if that's your base, there's no need to set it. The symbols can be omitted too, as Fixer will return all the supported currencies.
A simplified example without the base and currency:
$rates = (new Exchange())->get();The historical option will return currency rates for every day since the date you've specified. The base currency and symbols can be omitted here to, but let's see a full example:
$exchange = new Exchange();
$exchange->historical('2012-12-12');
$exchange->base(Currency::AUD);
$exchange->symbols(Currency::USD, Currency::EUR, Currency::GBP);
$rates = $exchange->get();Finally, you may have noticed the use of the Currency class with currencies as constants. It's just a convenience to prevent errors from typos, but they're completely optional.
This:
$exchange->base(Currency::AUD);
$exchange->symbols(Currency::USD, Currency::EUR, Currency::GBP);is equivalent to:
$exchange->base('AUD');
$exchange->symbols('USD', 'EUR', 'GBP');Use whatever method fills your needs.
The response is a simple array with currencies as keys and ratios as values. For a request like the following:
$rates = (new Exchange())->symbols(Currency::USD, Currency::GBP)->get();the response will be an array:
array('GBP' => 0.7009, 'USD' => 1.0666)which you can access with the keys as strings or using the currency constants:
print $rates['EUR'];
print $rates[Currency::GBP];The last option, probably more preferable by some, is handling the response as an object. It needs only an extra method:
$rates = (new Exchange())->symbols(Currency::USD, Currency::GBP)->asObject()->get();
print $rates->USD;
print $rates->GBP;To handle errors, the package provides 2 exceptions. ConnectionException when http requests go wrong and ResponseException when the returned response from the api is not as expected. An example with exception handling:
use Fadion\Fixerio\Exchange;
use Fadion\Fixerio\Exceptions\ConnectionException;
use Fadion\Fixerio\Exceptions\ResponseException;
try {
$exchange = new Exchange();
$rates = $exchange->get();
}
catch (ConnectionException $e) {
// handle
}
catch (ResponseException $e) {
// handle
}Nothing changes for Laravel apart from the Facade. It's just a convenience for a tad shorter way of using the package:
use Exchange;
use Fadion\Fixerio\Currency;
$rates = Exchange::base(Currency::USD)->get();