Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lexik/lexikcurrencybundle
This Symfony2 bundle provide a service and a Twig extension to convert and display currencies.
https://github.com/lexik/lexikcurrencybundle
bundle php symfony symfony-bundle
Last synced: 7 days ago
JSON representation
This Symfony2 bundle provide a service and a Twig extension to convert and display currencies.
- Host: GitHub
- URL: https://github.com/lexik/lexikcurrencybundle
- Owner: lexik
- License: mit
- Created: 2012-06-12T14:39:17.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2022-02-13T16:46:15.000Z (almost 3 years ago)
- Last Synced: 2024-04-25T22:21:56.132Z (8 months ago)
- Topics: bundle, php, symfony, symfony-bundle
- Language: PHP
- Size: 97.7 KB
- Stars: 58
- Watchers: 10
- Forks: 40
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Overview
========
This Symfony2 bundle provide a service and a twig extension to convert and display currencies.
[](http://travis-ci.org/lexik/LexikCurrencyBundle)
[](https://packagist.org/packages/lexik/currency-bundle)
[](https://insight.sensiolabs.com/projects/04079218-2ad1-439d-bfab-1c931468147c)
Installation
============
Add the bunde to your `composer.json` file:
```javascript
require: {
// ...
"lexik/currency-bundle": "~2.0"
// ...
}
```
**As of version `1.2.0`, `currency_format` does not convert the currency anymore, it only formats the given value according to the locale. If you need to convert and format a value, please use `currency_convert_format` filter.**
Then run a composer update:
```shell
composer.phar update
# OR
composer.phar update lexik/currency-bundle # to only update the bundle
```
Register the bundle with your kernel:
```
// in AppKernel::registerBundles()
$bundles = array(
// ...
new Lexik\Bundle\CurrencyBundle\LexikCurrencyBundle(),
// ...
);
```
Configuration
=============
Minimun configuration:
```yaml
# app/config/config.yml
lexik_currency:
currencies:
default: EUR # [required] the default currency
managed: [EUR, USD, ...] # [required] all currencies used in your app
```
Additonal options (default values are shown here):
```yaml
# app/config/config.yml
lexik_currency:
decimal_part:
precision: 2 # number of digits for the decimal part
round_mode: up # round mode to use (up|down|even|odd)
currency_class: Lexik\Bundle\CurrencyBundle\Entity\Currency # Use your custom Currency Entity
default_adapter: doctrine_currency_adapter # service id OR tag alias, this is adapter used by the conversion service
```
Initialize currencies
=====================
To initialize the currencies rate in the database run the following command:
```
./app/console lexik:currency:import
```
Example by using the ECB adapter, to get rates from the European Central Bank.
In the command line `ecb` is the value returned by the `getIdentifier()` method of the adapter class.
```
./app/console lexik:currency:import ecb
```
Usage
=====
##### Currency conversion service
Use the `convert()` method from the `lexik_currency.converter` service:
```php
get('lexik_currency.converter')->convert($amount, $targetCurrency);
// here the amount won't be rounded and we specify that $amount currency is 'USD'
$convertedAmount = $container->get('lexik_currency.converter')->convert($amount, $targetCurrency, false, 'USD');
```
##### Retrieve managed configurations
In the controller, you can use the following line to retrieve an array of all managed currencies:
```php
$managedCurrencies = $this->container->getParameter('lexik_currency.currencies.managed');
```
##### Twig filters
The bundle provide 3 filters to convert and format a value:
* `currency_convert`: convert a value.
* `currency_format`: format a value according to the current locale.
* `currency_convert_format`: convert and format a value.
Here an example with the `currency_convert_format` filter.
```
{% set targetCurrency = 'EUR' %}
{{ amount | currency_convert_format(targetCurrency) }}
```
You can also pass more arguments, to display or not decimal and the currency symbol. And you can specify the amount's currency if needed.
```
{% set targetCurrency = 'EUR' %}
{% set amountCurrency = 'USD' %}
{% set decimal = false %}
{% set symbol = true %}
{{ amount | currency_convert_format(targetCurrency, decimal, symbol, amountCurrency) }}
```
##### Load conversions rate from another source (custom CurrencyAdatpter)
If you need to load conversions rates from another source you will have to create a CurrencyAdatpter and set it as the default adapter.
To create your custom adapter you will have to extend `Lexik\Bundle\CurrencyBundle\Adapte\AbstractCurrencyAdapter` which define 2 abstract methods:
* getIdentifier(): returns the identifier of the adapter.
* attachAll(): loads the currencies with their rate (this method is call from the import command to get all currencies to save in the database).
Here an example
```php
currencyClass;
$euro->setCode('EUR');
$euro->setRate($defaultRate);
$this[$euro->getCode()] = $euro;
// Get other currencies
$currencies = // get all currencies with their rate (from a file, an url, etc)
foreach ($currencies as $code => $rate) {
if (in_array($code, $this->managedCurrencies)) { // you can check if the currency is in the managed currencies
$currency = new $this->currencyClass;
$currency->setCode($code);
$currency->setRate($rate);
$this[$currency->getCode()] = $currency;
}
}
// get the default rate from the default currency defined in the configuration
if (isset($this[$this->defaultCurrency])) {
$defaultRate = $this[$this->defaultCurrency]->getRate();
}
// convert rates according to the default one.
$this->convertAll($defaultRate);
}
/**
* {@inheritdoc}
*/
public function getIdentifier()
{
return 'rainbow';
}
}
```
Then define the adapter as a service, don't forget the `lexik_currency.adapter` tag:
```xml
%lexik_currency.currencies.default%
%lexik_currency.currencies.managed%
%lexik_currency.currency_class%
```
And import the currencies by using your adapter:
```
./app/console lexik:currency:import rainbow
```