MichaelRubel\ValueObjects\Collection\Primitive\Number

Complexity

Total Complexity

3

Size/Duplication

Total Lines	38
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	value()	0	3	1
A	__construct()	0	3	1
A	asInteger()	0	3	1

<?php

declare(strict_types=1);

/**
 * This file is part of michael-rubel/laravel-value-objects. (https://github.com/michael-rubel/laravel-value-objects)
 *
 * @link https://github.com/michael-rubel/laravel-value-objects for the canonical source repository
 * @copyright Copyright (c) 2022 Michael Rubél. (https://github.com/michael-rubel/)
 * @license https://raw.githubusercontent.com/michael-rubel/laravel-value-objects/main/LICENSE.md MIT
 */

namespace MichaelRubel\ValueObjects\Collection\Primitive;

use MichaelRubel\ValueObjects\Concerns\SanitizesNumbers;
use MichaelRubel\ValueObjects\ValueObject;
use PHP\Math\BigNumber\BigNumber;

/**
 * "Number" object that represents numeric values.
 *
 * @author Michael Rubél <michael@laravel.software>
 *
 * @template TKey of array-key
 * @template TValue
 *
 * @method static static make(int|string $number, int $scale = 2)
 * @method static static from(int|string $number, int $scale = 2)
 * @method static static makeOrNull(int|string|null $number, int $scale = 2)
 *
 * @extends ValueObject<TKey, TValue>
 */
class Number extends ValueObject
{
    use SanitizesNumbers;

    /**
     * @var BigNumber
     */
    protected BigNumber $bigNumber;

    /**
     * Create a new instance of the value object.
     *
     * @param  int|string  $number
     * @param  int  $scale
     */
    public function __construct(int|string $number, protected int $scale = 2)
    {
        $this->bigNumber = new BigNumber($this->sanitize($number), $this->scale);
    }

    /**
     * Get the object value.
     *
     * @return string
     */
    public function value(): string
    {
        return $this->bigNumber->getValue();
    }

    /**
     * Get the number as an integer.
     *
     * @return int
     */
    public function asInteger(): int
    {
        return (int) $this->bigNumber->getValue();
    }
}