Money module: reference information

Spryker handles all monetary values as integers and provides conversions from decimal values to cent values and vice-versa.

The key feature of this module is to convert a MoneyTransfer into the proper string version of it, given the current locale and currency.

Usage

The Money module is very straight forward and easy to use. MoneyFacade exposes the following methods:

• MoneyFacade::fromInteger()
• MoneyFacade::fromFloat()
• MoneyFacade::fromString()
• MoneyFacade::formatWithCurrency()
• MoneyFacade::formatWithoutCurrency()
• MoneyFacade::convertIntegerToDecimal()
• MoneyFacade::convertDecimalToInteger()

MoneyFacade::from*() methods

Internally, a powerful implementation of the Money Pattern is used. Outside the Money module, you only see the MoneyTransfer, which encapsulates our internals.

To get a money object, call the MoneyFacade::from*() methods:

All of them return a MoneyTransfer with a MoneyTransfer::$amount of ‘1000'.

• In case you don’t pass a currency, the currency configured as default is used.
• If you pass a specific currency, it is used instead of the one that’s configured as default.

MoneyFacade::formatWithSymbol()

The MoneyFacade::formatWithSymbol() method accepts only one argument — a MoneyTransfer. It will return a string representation of the given object, considering the current locale.

MoneyFacade::formatWithoutSymbol()

MoneyFacade::formatWithoutSymbol() method has the same behavior as MoneyFacade::formatWithSymbol(), except the fact that the currency symbol is not included.

MoneyFacade::convertIntegerToDecimal()

In some cases, you need a plain decimal representation of the value in integer (for example, cents). This can be useful, for example, for API calls.

MoneyFacade::convertDecimalToInteger()

In some cases, you need an integer (for example, cents) representation for a decimal value. This can be useful for storing monetary values in the database.

Money collection form type

From Money version 2.2.*, you can have a money collection form type inside your forms which let you include a complex form collection that render a table with currency per store and gross/net price.

For example, add FormBuilder in your form type:

/**
 * @param /Symfony/Component/Form/FormBuilderInterface $builder
 *
 * @return $this
 */
protected function addMoneyValueCollectionType(FormBuilderInterface $builder)
	{
    	$builder->add(
        	DiscountCalculatorTransfer::MONEY_VALUE_COLLECTION, //is the property in the main form you want to map. It must be transferred as in example
         	MoneyCollectionType::class,
            	[
                	MoneyCollectionType::OPTION_AMOUNT_PER_STORE => false, //If you want to render per store, set it to true
              	]
        );

        return $this;
	}

Also, modify the twig template to include the form money value collection table.

 {{ form_money_collection(mainForm.moneyValueCollection) }} 

This renders the table with all currencies enabled in the store. You have to handle persistence yourself, which means that you have to save and read data to the MoneyValueTransfer collection.