A package for handling numbers in Laravel.
You can install the package via composer:
composer require worksome/numberuse Worksome\Number\Number;
$number = Number::of(100);
$number->mul(Number::of(5));
echo $number; // 500This package allows you to easily cast attributes on your Eloquent models to number types.
use Illuminate\Database\Eloquent\Model;
use Worksome\Number\Casts\NumberFromCents;
use Worksome\Number\Casts\NumberFromDecimal;
use Worksome\Number\MonetaryAmount;
use Worksome\Number\Percentage;
use Worksome\Number\Number;
class Product extends Model
{
protected $casts = [
'a' => NumberFromCents::class,
'b' => NumberFromDecimal::class,
'c' => NumberFromDecimal::using(2, MonetaryAmount::class), // Cast to a specialised Number-class
'd' => NumberFromDecimal::using(2, Percentage::class), // Cast to a specialised Number-class
'e' => NumberFromDecimal::using(3), // Three decimal places - default is 2
];
}The following Number types are available out of the box:
Number- The base number type, with two decimal places. Can be configured to use a different default scale.MonetaryAmount- A number type for handling monetary amounts. Always uses two decimal places. Rounds automatically in all operations.Percentage- A number type for handling percentages. Makes it clear that the number represents a percentage, not an amount. Adds % on to string representations.
This package also provides GraphQL scalar types for the WebOnyx GraphQL PHP package / Lighthouse.
These will be auto-registered by Worksome\Number\Providers\NumberServiceProvider, however if you want to do this manually, they can be registered in the type registry using:
// In Lighthouse (https://lighthouse-php.com)
$typeRegistry->register(new \Worksome\Number\GraphQL\Scalars\DecimalTwoType());
$typeRegistry->register(new \Worksome\Number\GraphQL\Scalars\PercentageType());
$typeRegistry->register(new \Worksome\Number\GraphQL\Scalars\StrictPercentageType());composer testTo update Pest snapshots, run the following:
vendor/bin/pest -d --update-snapshotsPlease see GitHub Releases for more information on what has changed recently.
The MIT License (MIT). Please see License File for more information.