Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/akaunting/laravel-money
Currency formatting and conversion package for Laravel
https://github.com/akaunting/laravel-money
akaunting currency currency-converter laravel money php
Last synced: about 9 hours ago
JSON representation
Currency formatting and conversion package for Laravel
- Host: GitHub
- URL: https://github.com/akaunting/laravel-money
- Owner: akaunting
- License: mit
- Created: 2017-11-26T22:23:16.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-09-26T08:45:54.000Z (about 2 months ago)
- Last Synced: 2024-11-06T23:14:20.327Z (9 days ago)
- Topics: akaunting, currency, currency-converter, laravel, money, php
- Language: PHP
- Homepage: https://akaunting.com
- Size: 145 KB
- Stars: 731
- Watchers: 16
- Forks: 100
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Currency formatting and conversion package for Laravel
[](https://styleci.io/repos/112121508)
[](https://github.com/akaunting/laravel-money/actions/workflows/check_imports.yml)
[](LICENSE.md)
This package intends to provide tools for formatting and conversion of monetary values in an easy, yet powerful way for Laravel projects.
### Why not use the `moneyphp` package?
Because it uses the `intl` extension for number formatting. `intl` extension isn't present by default on PHP installs and can give [different results](http://moneyphp.org/en/latest/features/formatting.html#intl-formatter) in different servers.
## Getting Started
### 1. Install
Run the following command:
```bash
composer require akaunting/laravel-money
```
### 2. Publish
Publish config file.
```bash
php artisan vendor:publish --tag=money
```
### 3. Configure
You can change the currencies information of your app from `config/money.php` file
## Usage
```php
use Akaunting\Money\Currency;
use Akaunting\Money\Money;
echo Money::USD(500); // '$5.00' unconverted
echo new Money(500, new Currency('USD')); // '$5.00' unconverted
echo Money::USD(500, true); // '$500.00' converted
echo new Money(500, new Currency('USD'), true); // '$500.00' converted
```
### Advanced
```php
$m1 = Money::USD(500);
$m2 = Money::EUR(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::GBP(), 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
```php
money(500)
money(500, 'USD')
currency('USD')
```
### Blade Directives
```php
@money(500)
@money(500, 'USD')
@currency('USD')
```
### Blade Component
Same as the directive, there is also a `blade` component for you to create money and currency in your views:
```html
or
or
```
### Macros
This package implements the Laravel `Macroable` trait, allowing macros and mixins on both `Money` and `Currency`.
Example use case:
```php
use Akaunting\Money\Currency;
use Akaunting\Money\Money;
Money::macro(
'absolute',
fn () => $this->isPositive() ? $this : $this->multiply(-1)
);
$money = Money::USD(1000)->multiply(-1);
$absolute = $money->absolute();
```
Macros can be called statically too:
```php
use Akaunting\Money\Currency;
use Akaunting\Money\Money;
Money::macro('zero', fn (?string $currency = null) => new Money(0, new Currency($currency ?? 'GBP')));
$money = Money::zero();
```
### Mixins
Along with Macros, Mixins are also supported. This allows merging another classes methods into the Money or Currency class.
Define the mixin class:
```php
use Akaunting\Money\Money;
class CustomMoney
{
public function absolute(): Money
{
return $this->isPositive() ? $this : $this->multiply(-1);
}
public static function zero(?string $currency = null): Money
{
return new Money(0, new Currency($currency ?? 'GBP'));
}
}
```
Register the mixin, by passing an instance of the class:
```php
Money::mixin(new CustomMoney);
```
The methods from the custom class will be available:
```php
$money = Money::USD(1000)->multiply(-1);
$absolute = $money->absolute();
// Static methods via mixins are supported too:
$money = Money::zero();
```
## Changelog
Please see [Releases](../../releases) for more information on what has changed recently.
## Contributing
Pull requests are more than welcome. You must follow the PSR coding standards.
## Security
Please review [our security policy](https://github.com/akaunting/laravel-money/security/policy) on how to report security vulnerabilities.
## Credits
- [Denis Duliçi](https://github.com/denisdulici)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [LICENSE](LICENSE.md) for more information.