README

The purpose of this bundle is straightforward: using the moneyphp/money library with a single currency.

The typical use is when you need to map an amount of money to a database field. You could embed the Money object in your entity, but this is not perfectly working, because Doctrine doesn't support nullable embeddable objects.

Moreover, you probably want to use a single currency in your project, so you don't want to use a useless column for the currency itself.

With this bundle, you can use "money" as a type. It's up to you to choose if your property is nullable or not (as for any other Doctrine mapping, the default option is not nullable). You're done: your property will be mapped to a Money EUR object (see below for customisations).

Installation

Execute composer require garak/money-bundle.

Mapping example

<?php

namespace App\Entity;

use Money\Money;

class Foo
{
    public __construct(
        public int $id, 
        public \DateTimeImmutable $date, 
        public ?string $notes, 
        public Money $payment,
    ) {
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<doctrine-mapping
    xmlns="http://doctrine-project.org/schemas/orm/doctrine-mapping"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="https://doctrine-project.org/schemas/orm/doctrine-mapping https://doctrine-project.org/schemas/orm/doctrine-mapping.xsd"
>
    <entity name="App\Entity\Foo">
        <id name="id"/>
        <field name="date" type="date_immutable"/>
        <field name="notes" type="text" length="65535" nullable="true"/>
        <field name="payment" type="money"/>
    </entity>
</doctrine-mapping>

Form type extension

This bundle configures a form type extension for the Symfony MoneyType, which does two things:

• set the default option of divisor to 100 (which should be the value to use with most currencies)
• cast the submitted value to an integer, which is the format expected by moneyphp/money. The submitted value can be cast directly to a Money object by configuring the bundle option money_transform to true

You don't need to do anything to use this extension, which is automatically applied.

Twig extension

This bundle exposes a Twig filter called money. It's useful to format the value of your money property.

Example:

{# if the value in the database is 5099, this will display "€50,99" #}
{{ foo.payment|money }}

If the value is nullable, you can use the nullable_money filter instead:

{# display "€50,99" for 5099 and nothing for null #}
{{ foo.paymentOrNull|nullable_money }}

Customisations

You can use a currency different from EUR. Also, you can customise the separators used by the Twig extension, and have the symbol after the amount (with a space, if you want). Finally, you can enable the transformation of the submitted value to a Money object in the form type extension.

Here's an example of a configuration file:

money:
  currency: CHF         # default "EUR"
  decimal: "."          # default ","
  thousands: ","        # default "."
  after: true           # default false
  space: true           # default false
  money_transform: true # default false