A Symfony bundle to integrate Money PHP into your application.
-
Twig Extensions - display and manipulate Money objects in Twig templates
-
Doctrine Support - persist Money objects in your storage layer
-
Custom Serializer - serialize Money objects to and from string or array values
-
Custom Form Type - use Money objects in form data classes
Simply install with Composer in the usual way.
composer require headsnet/money-bundle
Then add to your bundles.php
file.
Headsnet\MoneyBundle\HeadsnetMoneyBundle::class => ['all' => true]
The bundle provides a custom Doctrine Type for the Currency
element of the Money object, and then a Doctrine
Embeddable for use in your models.
The data type for the amount
column is set to integer
which is evidently a contentious issue as the Money object
uses strings internally, but having the database use an integer type allows native sorting and summing etc.
The bundle provides a form type with a Data Transformer, that extends the Symfony MoneyType
.
The field will render a Money field, with the Money value object converted to readable values.
The bundle provides a Twig filter which formats a Money object in to a number with a currency symbol.
{{ object.amount|money }} # Renders e.g. "€10.00"
The bundle also provides a Twig utility that allows you to create a Money object directly in the template.
money(AMOUNT, 'CURRENCY_CODE')
This is generally useful for creating a variable which you then add values to in a loop. E.g.
{% set total = money(0, 'EUR') %}
{% for line in order.lines %}
{% set total = total.add(line.cost) %}
{% endfor %}
Total: {{ total|money }}
The bundle provides a Symfony normalizer for the Money object.
$amount = Money::EUR(200);
$serializer->serialize($amount, 'json'); // ==> '{"amount":"200","currency":"EUR"}'
Contributions are welcome. Please submit pull requests with one fix/feature per pull request.
Composer scripts are configured for your convenience:
> composer cs # Run coding standards checks
> composer cs-fix # Fix coding standards violations
This code is released under the MIT licence. Please see the LICENSE file for more information.