vojtasvoboda/oc-cnbrates-plugin

ČNB rates plugin for OctoberCMS

ČNB Rates plugin for OctoberCMS

, _(*1)

ČNB Rates plugin provide financial data from ČNB (Czech National Bank)., _(*2)

Implemented ČNB services: Exchange rates, PRIBOR rates., _(*3)

Features: - automatically daily update - fires event after update, so integration is very easy - prepared for implementating other ČNB services - covered by unit tests, _(*4)

Required plugins: none. Tested with the latest stable OctoberCMS build 349., _(*5)

Installation

• install plugin VojtaSvoboda.CnbRates from your Backend -> Settings -> System -> Updates -> Install plugins
• select which services you want to use at Settings -> System -> Misc -> ČNB Rates

Events

The best and easiest way how to use this plugin is by events., _(*6)

This plugin provide two events. When you set Scheduled updates correctly (see below), this events will be fired each day automatically and always comes with fresh rates data., _(*7)

• vojtasvoboda.cnbrates.exchange.updated Fired when exchange rates are updated
• vojtasvoboda.cnbrates.pribor.updated Fired when PRIBOR rates are updated

Using event in your Plugin.php:, _(*8)

public function boot()
{
    // ČNB rates update listener
    Event::listen('vojtasvoboda.cnbrates.exchange.updated', function($rates)
    {
        // update my plugin with fresh data
        $this->updateMyProducts($rates);
    });
}

All methods are fired after calling update method e.g. updateTodayExchangeRates() manually or by scheduler., _(*9)

Scheduled updates

For scheduled updates to operate correctly, you should add the following Cron entry to your server. Editing the crontab is commonly performed with the command crontab -e., _(*10)

* * * * * php /path/to/artisan schedule:run >> /dev/null 2>&1, _(*11)

Be sure to replace /path/to/artisan with the absolute path to the artisan file in the root directory of October., _(*12)

Thats all, rates will be updated every day and related events will be fired., _(*13)

Exchange rates service

Data are taken from official daily exchange rate list., _(*14)

Get all exchange rates

$cnb = App::make('cnb');
// rates for today
$rates = $cnb->getExchangeRates();
// for specific date
$rates = $cnb->getExchangeRates('12.1.2016');

Get exchange rate only for EUR currency

$cnb = App::make('cnb');
// rates for today
$rates = $cnb->getExchangeRate();
// for specific date
$rates = $cnb->getExchangeRate('12.1.2016');

Callable service used for CRON call

Downloads daily exchange rates, saves it to cache and fires vojtasvoboda.cnbrates.exchange.updated event. This method is prepared for using by CRON (see Setting CRON section)., _(*15)

$cnb = App::make('cnb');
$cnb->updateTodayExchangeRates();

PRIBOR rates service

Data are taken from official daily PRIBOR rate list., _(*16)

More about PRIBOR., _(*17)

PRIBOR is changed daily and is calculated for these intervals: year, 9 months, 6 months, 3 months, 2 months, month, 2 weeks, week and for one day., _(*18)

Get all PRIBOR rates

$cnb = App::make('cnb');
// rates for today
$rates = $cnb->getPriborRates();
// for specific date
$rates = $cnb->getPriborRates('12.1.2016');

Get PRIBOR rate only for concrete interval

$cnb = App::make('cnb');
// today yearly PRIBOR rate
$rates = $cnb->getPriborRate($date = null, $interval = 'year');
// or shortcuts
$rates = $cnb->getPriborRateForYear('12.1.2016');
$rates = $cnb->getPriborRateFor9Months('12.1.2016');
$rates = $cnb->getPriborRateFor6Months('12.1.2016');
$rates = $cnb->getPriborRateFor3Months('12.1.2016');
$rates = $cnb->getPriborRateFor2Months('12.1.2016');
$rates = $cnb->getPriborRateForMonth('12.1.2016');
$rates = $cnb->getPriborRateFor2Weeks('12.1.2016');
$rates = $cnb->getPriborRateForWeek('12.1.2016');
$rates = $cnb->getPriborRateForDay('12.1.2016');

Callable service used for CRON call

Download daily exchange rates, save it to cache and fires vojtasvoboda.cnbrates.exchange.updated event. This method is prepared for using by CRON., _(*19)

$cnb = App::make('cnb');
$cnb->updateTodayExchangeRates();

Testing

Run phpunit command in plugin directory. All test must pass., _(*20)

Future plans

Feel free to send pullrequest!, _(*21)

• [ ] implement other ČNB services
• [ ] add button 'Update rates now'

License

ČNB Rates plugin is open-sourced software licensed under the MIT license same as OctoberCMS platform., _(*22)

Contributing

Please send Pull Request to master branch., _(*23)