elv1ss/currency

Handles currency for Laravel 5.

v1.0.3 2015-09-01 12:42 UTC

README

Latest Stable Version Total Downloads

Handles currency for Laravel 5.

Installation

To get the latest version of Currency simply require it in your composer.json file.

"elv1ss/currency": "dev-master"

You'll then need to run composer install to download it and have the autoloader updated.

Once Currency is installed you need to register the service provider with the application. Open up app/config/app.php and find the providers key.

'providers' => [

    elv1ss\Currency\CurrencyServiceProvider::class,

]

Currency also ships with a facade which provides the static syntax for creating collections. You can register the facade in the aliases key of your app/config/app.php file.

'aliases' => [

    'Currency'  => elv1ss\Currency\Facades\Currency::class,

]

Create configuration file and migration table using artisan

$ php artisan vendor:publish

Artisan Commands

Updating Exchange

By default exchange rates are updated from Finance Yahoo.com.

php artisan currency:update

To update from OpenExchangeRates.org

php artisan currency:update --openexchangerates

Note: An API key is needed to use OpenExchangeRates.org. Add yours to the config file.


To update from The Central Bank of the Russian Federation (www.cbr.ru)

php artisan currency:update --cbr


To update from National Bank of the Republic of Belarus (www.nbrb.by)

php artisan currency:update --nbrb


### Cleanup

Used to clean the Laravel cached exchanged rates and refresh it from the database. Note that cached exchanged rates are cleared after they are updated using one of the command above.

php artisan currency:cleanup


## Convert
~~~php
// for example convert USD to EUR
echo Currency::convert(100, 'USD', 'EUR');
  • The first parameter is the amount.
  • The second parameter is the ISO 4217 From currency code.
  • The third parameter is the ISO 4217 To currency code.

Rendering

Using the Blade helper

@currency(12.00, 'USD')
  • The first parameter is the amount.
  • optional The second parameter is the ISO 4217 currency code. If not set it will use the default set in the config file.
echo Currency::format(12.00, 'USD');

For easy output of rounded values:

echo Currency::rounded(12.80);  // Will output $12

// All the parameters
echo Currency::rounded(12.80, 0, 'USD');

Change Log