quicktech-as / exchange-rate
Package Laravel to currency conversion using ExchangeRate API.
1.0.0
2017-05-05 00:35 UTC
Requires
- php: >=5.4.0
- guzzlehttp/guzzle: ^6.2
- illuminate/support: ^5.2
Requires (Dev)
- phpunit/phpunit: ^6.1
- squizlabs/php_codesniffer: ^3.0
This package is not auto-updated.
Last update: 2024-12-22 03:28:01 UTC
README
Quicktech\ExchangeRate is a succinct and flexible way to use ExchangeRate API to convert currencies in Laravel 5 applications.
Contents
Installation
- In order to install Laravel 5, just add the following to your composer.json. Then run
composer update
:
"quicktech-as/exchange-rate": "^1.0"
- Open your
config/app.php
and add the following to theproviders
array:
Quicktech\ExchangeRate\ExchangeRateServiceProvider::class,
- In the same
config/app.php
and add the following to thealiases
array:
'ExchangeRate' => Quicktech\ExchangeRate\Facade\ExchangeRate::class,
- Run the command below to publish the package config file
config/exchange_rate.php
:
php artisan vendor:publish
Configuration
Open your .env
file and setup your ExchangeRate credentials:
EXCHANGERATE_DEFAULT_CURRENCY = 'your default currency' EXCHANGERATE_API_KEY = 'your api key' EXCHANGERATE_API_URI = 'https://v3.exchangerate-api.com'
Usage
Get rates based on default currency
To get all rates based on your defult currency, you can use this resource:
$rates = ExchangeRate::rates();
The method above will return the following response:
[ "AUD" => 1.32230, "BGN" => 1.8096, "BRL" => 3.11, "..." => 1.31135, "..." => 7.473, etc. etc. ]
Convert currency value
To convert currency value, you can use this resource:
$value = ExchangeRate::convert(10.00, 'USD', 'BRL'); // 31.11
License
Quicktech\ExchangeRate is free software distributed under the terms of the MIT license.
Contribution guidelines
Please report any issue you find in the issues page.
Pull requests are welcome.