nilz/money

Implementation of money class

1.10 2023-10-20 13:50 UTC

Requires

• php: >=7.4
• ext-intl: *
• alcohol/iso4217: ~4.0

Requires (Dev)

• phpunit/phpunit: ~9.0

MIT

• Nils Weidl
• Daniel Reichenbach

README

A real world implementation of an extendable Money object using integers of smallest currency unit as calculation.

This library was created because other existing solutions had one or more of the following drawbacks:

• missing extendability of Money class
• dependency on fixed currency class
• missing methods like format and convertTo currency
• errors in implementation that caused to have rounding errors and missing cents in e.g. summing up prices
• library not being maintained anymore

Free to use. Use it or leave it.

Examples

Create a money object:

use Nilz\Money\Money;
use Nilz\Money\Currency\ISO4217Currency;

$money = new Money(420, new ISO4217Currency('EUR'));

$money = Money::fromDefaultUnitAmount('4.20', 'EUR');

Get amount of money object:

//420
echo $money->getAmount();

//4.20
echo $money->getDefaultUnitAmount();

//4,20 €
echo $money->getFormattedAmount('de_DE');

Sum up two money objects:

$a = Money::fromDefaultUnitAmount('4.20', 'EUR');
$b = Money::fromDefaultUnitAmount('2.10', 'EUR');

$c = $a->add($b);

//6.30
echo $c->getAmount();

//4.20
echo $a->getAmount();

//2.10
echo $b->getAmount();

Other arithmetic examples:

$a = Money::fromDefaultUnitAmount('4.20', 'EUR');
$b = Money::fromDefaultUnitAmount('2.10', 'EUR');

$a->subtract($b);

$a->multiply(1.2);
$a->divide(1.2);

If you need other methods to perform calculations, you can easily extend the money object or put a pull request to extend it.

Use custom currency:

use Nilz\Money\Currency\Currency;

//alpha3 code, factor for smallest unit representation, decimal digits to round two
$money = new Money(420, new Currency('EUR', 100, 2));

You can also implement a custom currency object by implementing the CurrencyInterface.