marleysidapple/currency

currency api for laravel

dev-master 2016-09-12 10:14 UTC

This package is auto-updated.

Last update: 2020-09-06 05:04:18 UTC


README

Get latest currency exchange rates for different dates.

Prerequisities

this will require guzzle. so first make sure you have installed guzzle.

"guzzlehttp/guzzle": "~4.0"

Installing

To install, edit your composer.json and add the line mentioned below.

"marleysidapple/currency": "dev-master"

Then run composer update

Configuration

After installation, go to config/app.php. Add in provider array

 Marleysid\Currency\CurrencyServiceProvider::class,

Add alias as well in alias array

 'Currency'=> Marleysid\Currency\Facade\CurrencyFacade::class,

For publishing configuration. Run following command

php artisan vendor:publish

Once publish is completed, open config/currency.php. It contains two element. One is url which is an api endpoint and another one is baseCurrency. You can change baseCurrency and set standard currency of your own, however url value is not meant to be changed.

##Example

add use Currency; in the top of the controller.

$exchangeRate = Currency::exchangeRate('baseCurrency', 'date', 'conversionCurrency');

if baseCurrency is set to GBP, all the conversion rates will be show in respect to GBP as a base. Passing date will give the exchange rate for that particular date. And passing conversionCurrency will give the exchange Rate for that particular conversionCurrency in respect to the specified baseCurrency.

##Usage

$exRate = Currency::exchangeRate('USD');

returns all available exrates with respect to the USD as a base currency for present date.

$exRate = Currency::exchangeRate('USD', '2015-10-23');

returns exrates for the specified date

$exRate = Currency::exchangeRate('USD', '2015-10-23', 'AUD');

returns exrate of 1 USD to 1 AUD on specified date

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Authors

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments