money/money

PHP implementation of Fowler's Money pattern

2.0.3 2014-04-20 16:04 UTC

Requires

• php: >=5.3.3

Requires (Dev)

• phpunit/phpunit: 3.7.*

Suggests

• Sylius/SyliusMoneyBundle: Sylius' Symfony2 integration with Money library
• TheBigBrainsCompany/TbbcMoneyBundle: Very complete Symfony2 bundle with support for Twig, Doctrine, Forms, ...
• pink-tie/money-bundle: Pink-Tie's Symfony2 integration with Money library

MIT

• Mathias Verraes
• Gustavo Santos
• Hassan AMOUHZI
• Aken Roberts

• money
• ddd
• Value Object
• Generic Sub-domain
• domain-driven design

README

Fork from Mathias Verraes implementation of Fowley's money pattern.

The current version of the fork divverges from Fowley's pattern by using floats as parameters on the Money constructor. This was introduced in order to cater to the issue of large monetary entities overflowing PHP int size on 32 bits platforms. This will be dealt with on later releases of this fork, so expect API breakage on minor releases.

PHP 5.3+ library to make working with money safer, easier, and fun!

"If I had a dime for every time I've seen someone use FLOAT to store currency, I'd have $999.997634" -- Bill Karwin

In short: You shouldn't represent monetary values by a float. Wherever you need to represent money, use this Money value object.

<?php

use Money\Money;

$fiveEur = Money::EUR(5);
$tenEur = $fiveEur->add($fiveEur);

list($part1, $part2, $part3) = $tenEur->allocate(array(1, 1, 1));
assert($part1->equals(Money::EUR(334)));
assert($part2->equals(Money::EUR(333)));
assert($part3->equals(Money::EUR(333)));

The documentation is available at http://money.readthedocs.org

Installation

Install the library using composer. Add the following to your composer.json:

{
    "require": {
        "hemeragestao/money": "2.0.*"
    } 
}

Now run the install command.

$ composer.phar install

Added Features

This fork replaces the maping of currencies from a simple ISO 4217 map from openexchangerates.org with the data contained in Ruby's Money mapping. This allows for a few additional features, including generating formatted output string for the Money objects. Also, the Money object constructor takes a float parameter, using it as the amount instead of units. This will be changed on later releases.

<?php

use Money\Money;

echo Money::EUR(5.32);

Output:

€ 5.32

Integration

See MoneyBundle or TbbcMoneyBundle for Symfony integration.