moneyphp/money

PHP implementation of Fowler's Money pattern

v4.5.1 2024-09-27 12:04 UTC

Requires

• php: ~8.1.0 || ~8.2.0 || ~8.3.0
• ext-bcmath: *
• ext-filter: *
• ext-json: *

Requires (Dev)

• ext-gmp: *
• ext-intl: *
• cache/taggable-cache: ^1.1.0
• doctrine/coding-standard: ^12.0
• doctrine/instantiator: ^1.5.0 || ^2.0
• florianv/exchanger: ^2.8.1
• florianv/swap: ^4.3.0
• moneyphp/crypto-currencies: ^1.1.0
• moneyphp/iso-currencies: ^3.4
• php-http/message: ^1.16.0
• php-http/mock-client: ^1.6.0
• phpbench/phpbench: ^1.2.5
• phpunit/phpunit: ^10.5.9
• psalm/plugin-phpunit: ^0.18.4
• psr/cache: ^1.0.1 || ^2.0 || ^3.0
• vimeo/psalm: ~5.20.0

Suggests

• ext-gmp: Calculate without integer limits
• ext-intl: Format Money objects with intl
• florianv/exchanger: Exchange rates library for PHP
• florianv/swap: Exchange rates library for PHP
• psr/cache-implementation: Used for Currency caching

MIT

• Mathias Verraes
• Márk Sági-Kazár
• Frederik Bosch

• money
• Value Object
• vo

README

PHP 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. Since version 3.0 this library uses strings internally in order to support unlimited integers.

<?php

use Money\Money;

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

list($part1, $part2, $part3) = $tenEur->allocate([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://moneyphp.org

Requirements

This library requires the BCMath PHP extension. There might be additional dependencies for specific feature, e.g. the Swap exchange implementation, check the documentation for more information.

Version 4 requires PHP 8.0. For older version of PHP, use version 3 of this library. From version 4.5 this package will only support PHP versions that actually receive updates by PHP itself. If you want to use the package with older PHP versions, you can of course use older versions of this package.

Install

Via Composer

$ composer require moneyphp/money

Features

• JSON Serialization
• Big integer support utilizing different, transparent calculation logic upon availability (bcmath, gmp, plain php)
• Money formatting (including intl formatter)
• Currency repositories (ISO currencies included)
• Money exchange (including Swap implementation)

Documentation

Please see the official documentation.

Testing

We try to follow TDD by using phpunit to test this library.

$ composer test

Running the tests in Docker

Money requires a set of dependencies, so you might want to run it in Docker.

First, build the image locally:

$ docker build -t moneyphp .

Then run the tests:

$ docker run --rm -it -v $PWD:/app -w /app moneyphp vendor/bin/phpunit --exclude-group segmentation

Contributing

We would love to see you helping us to make this library better and better. Please keep in mind we do not use suffixes and prefixes in class names, so not CurrenciesInterface, but Currencies. Other than that, Style CI will help you using the same code style as we are using. Please provide tests when creating a PR and clear descriptions of bugs when filing issues.

Security

If you discover any security related issues, please contact us at [e-mail].

License

The MIT License (MIT). Please see License File for more information.

Acknowledgements

This library is heavily inspired by Martin Fowler's Money pattern. A special remark goes to Mathias Verraes, without his contributions, in code and via his blog, this library would not be where it stands now.