Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/imanilchaudhari/yii2-currency-converter
Yii2 Currency Converter
https://github.com/imanilchaudhari/yii2-currency-converter
Last synced: 2 days ago
JSON representation
Yii2 Currency Converter
- Host: GitHub
- URL: https://github.com/imanilchaudhari/yii2-currency-converter
- Owner: imanilchaudhari
- License: mit
- Created: 2015-08-04T20:01:08.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-08-02T19:47:21.000Z (5 months ago)
- Last Synced: 2024-12-25T12:07:50.380Z (9 days ago)
- Language: PHP
- Size: 62.5 KB
- Stars: 18
- Watchers: 2
- Forks: 10
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
Yii2 Currency Converter
[](https://packagist.org/packages/imanilchaudhari/yii2-currency-converter)
[](https://packagist.org/packages/imanilchaudhari/yii2-currency-converter)
[](https://travis-ci.org/imanilchaudhari/yii2-currency-converter)
[](https://codecov.io/gh/imanilchaudhari/yii2-currency-converter)
This extension will help to find out current currency conversion rate using various providers.
Documentation is at [docs/README.md](docs/README.md).
Version 1 docs are located at [here](https://github.com/imanilchaudhari/yii2-currency-converter/tree/1.1).
Requirements
-----------
* PHP version 7.4 or later
* Curl Extension (Optional)
Installation
------------
The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
Either run
```
php composer.phar require --prefer-dist imanilchaudhari/yii2-currency-converter "3.1"
```
or add
```
"imanilchaudhari/yii2-currency-converter": "3.1"
```
to the require section of your `composer.json` file.
Usage
-----
Once the extension is installed, use it in your code by adding the below code on the config's components :
```php
'components' => [
'currencyConverter' => [
'class' => 'imanilchaudhari\CurrencyConverter\CurrencyConverter',
'provider' => [
'class' => 'imanilchaudhari\CurrencyConverter\Provider\ExchangeRatesApi',
],
],
...
],
```
****and use as****
```
$rate = Yii::$app->currencyConverter->convert('USD', 'NPR');
```
***OR***
```php
use imanilchaudhari\CurrencyConverter\CurrencyConverter;
use imanilchaudhari\CurrencyConverter\Provider\ExchangeRatesApi;
$converter = new CurrencyConverter([
'provider' => [
'class' => ExchangeRatesApi::class,
],
]);
$rate = $converter->convert('USD', 'NPR');
print_r($rate); // it will print the current Nepalese currency (NPR) rate according to USD
```
Exchange Rate Providers
-----------------------
- [ApiForexApi](./src/Provider/ApiForexApi.php) - Get exchange rates from https://api.forex/
- [CurrencyApi](./src/Provider/CurrencyApi.php) - Get exchange rates from https://currencyapi.com/
- [CurrencyFreaksApi](./src/Provider/CurrencyFreaksApi.php) - Get exchange rates from https://currencyfreaks.com/
- [CurrencylayerApi](./src/Provider/CurrencylayerApi.php) - Get exchange rates from https://currencylayer.com/
- [ExchangeRatesApi](./src/Provider/ExchangeRatesApi.php) - Get exchange rates from https://www.exchangerate-api.com/ (Free, no billing required)
- [FixerApi](./src/Provider/FixerApi.php) - Get exchange rates from https://fixer.io/
- [OpenExchangeRatesApi](./src/Provider/OpenExchangeRatesApi.php) - Get exchange rates from https://openexchangerates.org/
## Testing
### Unit testing
The package is tested with [PHPUnit](https://phpunit.de/). To run tests:
```shell
./vendor/bin/phpunit
```
## License
The Yii2 Currency Converter is free software. It is released under the terms of the MIT License. Please see [`LICENSE`](./LICENSE.md) for more information.
[](https://www.yiiframework.com/)