daikon-cqrs / value-object

src/FloatValue.php

<?php declare(strict_types=1);
/**
 * This file is part of the daikon-cqrs/value-object project.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Daikon\ValueObject;

use Daikon\Interop\Assertion;
use Daikon\Interop\MakeEmptyInterface;

final class FloatValue implements MakeEmptyInterface, ValueObjectInterface
{
    private ?float $value;

    /** @param null|int|float $value */
    public static function fromNative($value): self
    {
        if (is_integer($value)) {
            $value = floatval($value);
        }
        Assertion::nullOrFloat($value, 'Trying to create FloatValue VO from unsupported value type.');
        return $value === null ? new self : new self(floatval($value));
    }

    public static function zero(): self
    {
        return new self(0.0);
    }

    public static function makeEmpty(): self
    {
        return new self;
    }

    public function format(int $decimals = 0, string $point = '.', string $separator = ','): string
    {
        $this->assertNotEmpty();
        return number_format($this->value, $decimals, $point, $separator);

It seems like $this->value can also be of type null; however, parameter $num of number_format() does only seem to accept double, maybe add an additional type check?

    }

    public function isEmpty(): bool
    {
        return $this->value === null;
    }

    public function isZero(): bool
    {
        $this->assertNotEmpty();
        return $this->value === 0.0;
    }

    public function toNative(): ?float
    {
        return $this->value;
    }

    /** @param self $comparator */
    public function equals($comparator): bool
    {
        Assertion::isInstanceOf($comparator, self::class);
        return $this->toNative() === $comparator->toNative();
    }

    public function __toString(): string
    {
        return (string)$this->value;
    }

    private function assertNotEmpty(): void
    {
        Assertion::false($this->isEmpty(), 'Float is empty.');
    }

    private function __construct(?float $value = null)
    {
        $this->value = $value;
    }
}