imanilchaudhari/yii2-currency-converter

This extension will help to find out current currency conversion rate.

Installs: 11 317

Dependents: 0

Suggesters: 0

Security: 0

Stars: 18

Watchers: 2

Forks: 10

Open Issues: 0

Type:yii2-extension

3.0 2024-04-06 11:06 UTC

This package is auto-updated.

Last update: 2024-06-06 19:36:51 UTC


README

68747470733a2f2f796969736f66742e6769746875622e696f2f646f63732f696d616765732f7969695f6c6f676f2e737667

Yii2 Currency Converter


Latest Stable Version Total Downloads Build Status Code Coverage

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

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.

Powered by