Currencies

Sylius supports multiple currencies per store and makes it very easy to manage them.

There are several approaches to processing several currencies, but we decided to use the simplest solution we are storing all money values in the base currency per channel and convert them to other currencies with exchange rates.

Note

The base currency to the first channel is set during the installation of Sylius and it has the exchange rate equal to “1.000”.

Tip

In the dev environment you can easily check the base currency in the Symfony debug toolbar:

../../_images/toolbar.png

Currency Context

By default, user can switch the current currency in the frontend of the store.

To manage the currently used currency, we use the CurrencyContext. You can always access it through the sylius.context.currency id.

<?php

public function fooAction()
{
    $currency = $this->get('sylius.context.currency')->getCurrency();
}

Currency Converter

The Sylius\Component\Currency\Converter\CurrencyConverter is a service available under the sylius.currency_converter id.

It lets you to convert money values from one currency to another.

This solution is used for displaying an approximate value of price when the desired currency is different from the base currency of the current channel.

Available Currencies Provider

The default menu for selecting currency is using a service - CurrencyProvider - with the sylius.currency_provider id, which returns all enabled currencies. This is your entry point if you would like override this logic and return different currencies for various scenarios.

<?php

public function fooAction()
{
    $currencies = $this->get('sylius.currency_provider')->getAvailableCurrencies();
}

Switching Currency of a Channel

We may of course change the currency used by a channel. For that we have the sylius.storage.currency service, which implements the Sylius\Component\Core\Currency\CurrencyStorageInterface with methods ->set(ChannelInterface $channel, $currencyCode) and ->get(ChannelInterface $channel).

$container->get('sylius.storage.currency')->set($channel, 'PLN');

Displaying Currencies in the templates

There are some useful helpers for rendering money values in the front end. Simply import the money macros of the ShopBundle in your twig template and use the functions to display the value:

..
{% import "@SyliusShop/Common/Macro/money.html.twig" as money %}
..

<span class="price">{{ money.format(price, 'EUR') }}</span>

Sylius provides you with some handy Global Twig variables to facilitate displaying money values even more.