egangloff/yii2-currencyconverter

Currency Converter using Fixer.io API

dev-master 2019-07-20 02:05 UTC

Requires

• yiisoft/yii2: *

MIT

• Eddy Gangloff

README

A Yii2 currency converter, based on Fixer.io API

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist egangloff/yii2-currencyconverter "dev-master"

or add

"egangloff/yii2-currencyconverter": "dev-master"

to the require section of your composer.json file.

Configuration

Config console modules in console/config/main.php

'bootstrap' => ['currencyconverter'],
'modules' => [
    'currencyconverter' => [
        'class' => 'egangloff\currencyconverter\CurrencyConverter',
        'access_key' => 'FIXER.IO API KEY',
        'currencies' => [
		'THB'=>'฿', 
		'USD'=>'$', 
		'EUR'=>'€ ',
		'CNY'=>'¥',
    ...
	],
        'currency_source' => 'THB',
    ],
],

Config frontend modules and components in frontend/config/main.php

'modules' => [
    'currencyconverter' => [
        'class' => 'egangloff\currencyconverter\CurrencyConverter',
        'access_key' => 'FIXER.IO API KEY',
        'currencies' => [
		'THB'=>'฿', 
		'USD'=>'$', 
		'EUR'=>'€ ',
		'CNY'=>'¥',
    ...
	],
        'currency_source' => 'THB',
    ],
],
'components' => [
    'currencyconverter' => [
        'class' =>  'egangloff/currencyconverter/components/CurrencyConverter',
    ]
],

Migration

./yii migrate --migrationPath=@vendor/egangloff/yii2-currencyconverter/migrations

Usage

Currency Converter Component

in your controller or view

use egangloff\currencyconverter\components\CurrencyConverter;

<?=CurrencyConverter::convert(YOUR_AMOUNT)?>

Currrency Selector Widget

Copy and change CSS in frontend/web/css/site.css

/* Currency Selector Widget */

.currency{
    text-align: center;
}

#currency-selector{
    margin: 15px;
    background-color: #337AB7;
    color: #fff;
    border: 0;
    -webkit-appearance: none;
    -moz-appearance: none;
}

in your view

use egangloff\currencyconverter\widgets\CurrencySelector;

<?=CurrencySelector::widget()?>

Update Currencies

In console

yii currencyconverter/console/update

You can also create a Cron Job for automatic update

crontab -e

0 0 * * * /usr/local/bin/php ~/webapps/toucanproperty/yii currencyconverter/console/update

Save and exit, it will automatically update currencies every days at midnight

You can adjust schedule using crontab.guru