laranex/laravel-money

A Laravel package to work with Money Fields

dev-main 2024-10-18 18:44 UTC

Requires

• php: ^8.2
• money/money: ^2.0
• spatie/laravel-package-tools: ^1.16

Requires (Dev)

• larastan/larastan: ^2.9
• laravel/pint: ^1.14
• nunomaduro/collision: ^8.1.1||^7.10.0
• orchestra/testbench: ^9.0.0||^8.22.0
• pestphp/pest: ^2.34
• pestphp/pest-plugin-arch: ^2.7
• pestphp/pest-plugin-laravel: ^2.3
• phpstan/extension-installer: ^1.3
• phpstan/phpstan-deprecation-rules: ^1.1
• phpstan/phpstan-phpunit: ^1.3

MIT

• Nay Thu Khant

• laravel
• laranex
• laravel-money

README

Tired of working with money fields in Laravel? This package is for you. It provides a simple way to work with money fields in Laravel. Before using this package, get yourself familiar with MoneyPHP.

Installation

You can install the package via composer:

composer require laranex/laravel-money

Usage

• parseMoney (A helper to convert string into Money/Money Object. See More At \Laranex\LaravelMoney\LaravelMoney.php

  (new \Laranex\LaravelMoney\LaravelMoney())->parseMoney($amount);
  \Laranex\LaravelMoney\Facades\LaravelMoney::parseMoney($amount);

• MoneyTrait (A trait to work with money fields in Laravel Eloquent Model. See More At \Laranex\LaravelMoney\HasMoneyFields.php

  use Laranex\LaravelMoney\Traits\HasMoneyFields;
  
  class Wallet extends Model
  {
      protected $moneyFields = ['balance'];
  
      use HasMoneyFields;
  }
  
  // Storing Money Field
  $wallet = new Wallet();
  $wallet->balance = \Laranex\LaravelMoney\Facades\LaravelMoney::parseMoney($amount);
  
  // Retrieving Money Field
  $wallet = Wallet::find(1);
  $moneyObject = $wallet->balance; // Returns Money Object

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Nay Thu Khant
• All Contributors

License

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