EasyAdmin Money Field
This field is used to represent the value of properties that store amounts of money.
In form pages (edit and new) it looks like this:
![Default style of EasyAdmin money field](/doc/bundles/EasyAdminBundle/4.x/field-money.png)
Basic Information
- PHP Class:
EasyCorp
\Bundle \EasyAdminBundle \Field \MoneyField - Doctrine DBAL Type used to store this value:
decimal
,float
orinteger
- Symfony Form Type used to render the field: MoneyType
Rendered as:
1
<input type="number">
Options
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 solves all the rounding problems that you'll find when storing money amounts using float or decimal numbers.
Tip
In Symfony/PHP applications you can use the Money PHP library to handle the conversion of money amounts from/into cents.
If you do not store money amounts in cents, set this option to false
:
yield MoneyField::new('...')->setStoredAsCents(false);
Note
When this option is enabled, the divisor
is set at 100
automatically.
However, if you've defined your own custom divisor with the
setFormTypeOption('divisor', ...)
method, the custom divisor will be used.