ongr/currency-exchange-bundle

ONGR currency exchange bundle

Thursday, November 24, 2016
by saimaz
Repository
16 Watchers
2 Stars
3,393 Installations

PHP
0 Dependents
0 Suggesters
7 Forks
0 Open issues
14 Versions
13 % Grown

The README.md

ONGR Currency Exchange Bundle

This bundle provides an easy way to display price in multiple currencies. It gives a solution to fetch and store current currency rates, to convert prices and display them in Twig templates., _(*1)

, _(*2)

Documentation

The documentation of the bundle can be found in Resources/doc/, _(*3)

Installation

Follow 5 quick steps to setup this bundle., _(*4)

Step 1: Download the Bundle

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:, _(*5)

$ composer require ongr/currency-exchange-bundle

This command requires you to have Composer installed globally, as explained in the installation chapter of the Composer documentation., _(*6)

Step 2: Enable the Bundle

class AppKernel extends Kernel
{
    public function registerBundles()
    {
        return [
            // ...
            new ONGR\ElasticsearchBundle\ONGRElasticsearchBundle(),
            new ONGR\CurrencyExchangeBundle\ONGRCurrencyExchangeBundle(),    
        ];
    }

    // ...
}

Step 3: Update Elasticsearch Mapping

This bundle provides Elasticsearch document to store currency rates. Add this bundle to your ES manager's mapping to associate it:, _(*8)

# app/config/config.yml
ongr_elasticsearch:
    # ...
    managers:
        default:
            # ...
            mappings:
                # ...
                - AppBundle
                - ONGRCurrencyExchangeBundle

Step 4: Configure the Bundle

Configure the currencies you need in config.yml file., _(*9)

# app/config/config.yml
ongr_currency_exchange:
    es_manager: default
    default_currency: EUR
    separators:
        decimal: ','
        thousands: '.'
    currencies:
        EUR: "%s €"    # %s stands for the price itself
        USD: "$ %s"

That's it for setup, jump to the next chapter to learn how to use this bundle., _(*10)

Usage

The main parts of this bundle are a command to update currency rates and Twig helpers to display price in various currencies., _(*11)

Before converting prices you need to fetch the latest currency rates:, _(*12)

$ app/console ongr:currency:update

Tip: setup a cron job to update currencies daily in your production environment., _(*13)

Now you are ready to use currency conversion logic in your templates. Here is a simple example how to convert currency:, _(*14)

<ul>
    <li>Price in default currency: {{ 123.123|ongr_price(2) }}
    <li>Price in US dollars: {{ 123.123|ongr_price(2, 'USD') }}
</ul>

In this example the number 2 represents the number of decimal points. It will print the following information:, _(*15)

Price in default currency: 123.12 €
Price in US dollars: $ 123.12

To learn more read about provided Twig helpers or check [example currency switching][7] implementation., _(*16)

License

This package is licensed under the MIT license. For the full copyright and license information, please view the LICENSE file that was distributed with this source code., _(*17)

The Versions

24/11 2016

dev-master

9999999-dev http://ongr.io

ONGR currency exchange bundle

Sources Download

MIT

The Requires

The Development Requires

by ONGR team

01/08 2016

2.0.x-dev

2.0.9999999.9999999-dev http://ongr.io

ONGR currency exchange bundle

Sources Download

MIT

The Requires

The Development Requires

by ONGR team

01/08 2016

v2.0.6

2.0.6.0 http://ongr.io

ONGR currency exchange bundle

Sources Download

MIT

The Requires

The Development Requires

by ONGR team

01/08 2016

dev-hotfix-date-saving

dev-hotfix-date-saving http://ongr.io

ONGR currency exchange bundle

Sources Download

MIT

The Requires

The Development Requires

by ONGR team

28/07 2016

v2.0.5

2.0.5.0 http://ongr.io

ONGR currency exchange bundle

Sources Download

MIT

The Requires

The Development Requires

by ONGR team

07/07 2016

v2.0.4

2.0.4.0 http://ongr.io

ONGR currency exchange bundle

Sources Download

MIT

The Requires

The Development Requires

by ONGR team

07/07 2016

v2.0.3

2.0.3.0 http://ongr.io

ONGR currency exchange bundle

Sources Download

MIT

The Requires

The Development Requires

by ONGR team

07/07 2016

v2.0.2

2.0.2.0 http://ongr.io

ONGR currency exchange bundle

Sources Download

MIT

The Requires

The Development Requires

by ONGR team

05/07 2016

v2.0.1

2.0.1.0 http://ongr.io

ONGR currency exchange bundle

Sources Download

MIT

The Requires

The Development Requires

by ONGR team

04/07 2016

v2.0.0

2.0.0.0 http://ongr.io

ONGR currency exchange bundle

Sources Download

MIT

The Requires

The Development Requires

by ONGR team

22/06 2016

1.0.x-dev

1.0.9999999.9999999-dev http://ongr.io

ONGR currency exchange bundle

Sources Download

MIT

The Requires

The Development Requires

by ONGR team

06/06 2016

v1.0.0

1.0.0.0 http://ongr.io

ONGR currency exchange bundle

Sources Download

MIT

The Requires

The Development Requires

by ONGR team

17/04 2015

v0.2.0

0.2.0.0 http://ongr.io

Sources Download

MIT

The Requires

The Development Requires

by ONGR team

30/01 2015

v0.1.0

0.1.0.0 http://ongr.io

Sources Download

MIT

symfony-bundle currency-exchange-bundle