iidestiny/laravel-money

Laravel Money

1.1 2022-04-15 03:06 UTC

Requires

• php: ^7.2.5|^8.0
• illuminate/support: ^6.0|^7.0
• illuminate/view: ^6.0|^7.0

Requires (Dev)

• mockery/mockery: ^1.3
• phpunit/phpunit: ^8.5|^9.0

Suggests

• ext-intl: Required to use NumberFormatter.

MIT

• Ricardo Gobbo de Souza

• money
• currency
• laravel

README

Installation

Run the following command from you terminal:

composer require cknow/laravel-money:~0.1.0

or add this to require section in your composer.json file:

"cknow/laravel-money": "~0.1.0"

then run composer update

In your config/app.php add 'ClickNow\Money\MoneyServiceProvider' to the end of the 'providers' array:

'providers' => array(
    ...
    ...
    ClickNow\Money\MoneyServiceProvider::class,
),

Usage

use ClickNow\Money\Money;

echo Money::BRL(500); // 'R$ 5,00' unconverted
echo new Money(500, new Currency('BRL')); // 'R$ 5,00' unconverted
echo Money::BRL(500, true); // 'R$ 500,00' converted
echo new Money(500, new Currency('BRL'), true); // 'R$ 500,00' converted

Advanced Usage

var $m1 = Money::BRL(500);
var $m2 = Money::BRL(500);

$m1->getCurrency();
$m1->isSameCurrency($m2);
$m1->compare($m2);
$m1->equals($m2);
$m1->greaterThan($m2);
$m1->greaterThanOrEqual($m2);
$m1->lessThan($m2);
$m1->lessThanOrEqual($m2);
$m1->convert(Currency::USD, 3.5);
$m1->add($m2);
$m1->subtract($m2);
$m1->multiply(2);
$m1->divide(2);
$m1->allocate([1, 1, 1]);
$m1->isZero();
$m1->isPositive();
$m1->isNegative();
$m1->format();

Helpers

money(500, 'BRL')
currency('BRL')

Blade Extensions

@money(500, 'BRL')
@currency('BRL')