imanilchaudhari / yii2-currency-converter
This extension will help to find out current currency conversion rate.
Installs: 11 199
Dependents: 0
Suggesters: 0
Security: 0
Stars: 18
Watchers: 2
Forks: 10
Open Issues: 0
Type:yii2-extension
Requires
- php: >=7.4.0
- yiisoft/yii2: ^2.0
- yiisoft/yii2-httpclient: ^2.0
Requires (Dev)
- phpunit/phpunit: ^9.6
- rector/rector: ^1.0
This package is auto-updated.
Last update: 2024-05-06 19:34:48 UTC
README
Yii2 Currency Converter
This extension will help to find out current currency conversion rate using various providers.
Documentation is at docs/README.md.
Version 1 docs are located at here.
Requirements
- PHP version 7.4 or later
- Curl Extension (Optional)
Installation
The preferred way to install this extension is through composer.
Either run
php composer.phar require --prefer-dist imanilchaudhari/yii2-currency-converter "3.0"
or add
"imanilchaudhari/yii2-currency-converter": "3.0"
to the require section of your composer.json
file.
Usage
Once the extension is installed, simply use it in your code by :
'components' => [ 'currencyConverter' => [ 'class' => 'imanilchaudhari\CurrencyConverter\CurrencyConverter', 'provider' => [ 'class' => 'imanilchaudhari\CurrencyConverter\Provider\ExchangeRatesApi', ], ], ... ], $converter = Yii::$app->currencyConverter; $rate = $converter->convert('USD', 'NPR');
OR
use imanilchaudhari\CurrencyConverter\CurrencyConverter; use imanilchaudhari\CurrencyConverter\Provider\OpenExchangeRatesApi; $converter = new CurrencyConverter([ 'provider' => [ 'class' => OpenExchangeRatesApi::class, 'appId' => Yii::$app->params['openExchangeRate']['appId'], ], ]); $rate = $converter->convert('USD', 'NPR'); print_r($rate); // it will print current Nepalese currency (NPR) rate according to USD
Exchange Rate Providers
- ApiForexApi - Get exchange rates from https://api.forex/
- CurrencyApi - Get exchange rates from https://currencyapi.com/
- CurrencyFreaksApi - Get exchange rates from https://currencyfreaks.com/
- CurrencylayerApi - Get exchange rates from https://currencylayer.com/
- ExchangeRatesApi - Get exchange rates from https://www.exchangerate-api.com/
- FixerApi - Get exchange rates from https://fixer.io/
- OpenExchangeRatesApi - Get exchange rates from https://openexchangerates.org/
Testing
Unit testing
The package is tested with PHPUnit. To run tests:
./vendor/bin/phpunit
License
The Yii2 Currency Converter is free software. It is released under the terms of the MIT License. Please see LICENSE
for more information.