EasyAdmin Money Field

setCurrency

The currency associated to the amount of money is needed to format the field value in read-only pages (index and detail). If the currency is known and the same for all values of the field, use this option (otherwise, use the setCurrencyPropertyPath option).

The method argument must be a valid ISO 4217 standard currency code:

1
2

// e.g. 'INR' = 'Indian Rupee'
yield MoneyField('...')->setCurrency('INR');

setCurrencyPropertyPath

The currency associated to the amount of money is needed to format the field value in read-only pages (index and detail). If the currency changes for each field value, you'll probably store that currency code (following the ISO 4217 standard) as a property of the entity.

Use this option to tell EasyAdmin which is the property that stores the currency code. The method argument is any valid Symfony PropertyAccess expression:

1
2
3

yield MoneyField('...')->setCurrencyPropertyPath('currency');
yield MoneyField('...')->setCurrencyPropertyPath('currencySymbol');
yield MoneyField('...')->setCurrencyPropertyPath('currency.code');

setNumDecimals

By default, money amounts are displayed formatted with 2 decimal numbers. Use this option if you want to format values with a different number of decimals:

1

yield MoneyField::new('...')->setNumDecimals(0);

setStoredAsCents

By default, EasyAdmin stores money amounts as cents. For example, "5 euros" is stored as the integer 500 (5 x 100 cents) and "349.99 yens" is stored as the integer 34,999.

Although it may seem over-complicated at first, this is the most recommended way to store money amounts in the database. Doing this prevents rounding errors that commonly occur when storing money amounts using float or decimal numbers.

If you do not store money amounts in cents, set this option to false:

yield MoneyField::new('...')->setStoredAsCents(false);

useMoneyObject

If your entity stores money amounts as Money\Money objects from the Money PHP library, EasyAdmin can handle them directly. First, install the library:

1

$ composer require moneyphp/money

When the property value is already a Money object (e.g. on edit and detail pages), EasyAdmin detects it automatically and no extra configuration is needed. On new pages, where the value is null, you must enable this option explicitly:

1

yield MoneyField::new('price')->useMoneyObject();

The currency is read from the Money object by default, but you can override it with setCurrency() or setCurrencyPropertyPath():

1

yield MoneyField::new('price')->useMoneyObject()->setCurrency('EUR');