ICanBoogie / CLDR

src/Numbers/Number.php

<?php

namespace ICanBoogie\CLDR\Numbers;

use function assert;
use function is_numeric;
use function is_string;
use function preg_match;
use function str_repeat;
use function strlen;
use function strpos;
use function strrpos;
use function substr;

final class Number
{
    /**
     * Returns the precision of a number.
     *
     * @param float|int|numeric-string $number

The doc comment float|int|numeric-string at position 4 could not be parsed: Unknown type name 'numeric-string' at position 4 in float|int|numeric-string.

     */
    public static function precision_from(float|int|string $number): int
    {
        $number = (string)$number;
        $pos = strrpos($number, '.');

        if (!$pos) {
            return 0;
        }

        return strlen($number) - $pos - 1;
    }

    /**
     * Returns a number rounded to the specified precision.
     *
     * @param float|int|numeric-string $number

The doc comment float|int|numeric-string at position 4 could not be parsed: Unknown type name 'numeric-string' at position 4 in float|int|numeric-string.

     */
    public static function round_to(float|int|string $number, int $precision): float
    {
        return round($number + 0, $precision);
    }

    /**
     * Parses a number.
     *
     * @param float|int|numeric-string $number

The doc comment float|int|numeric-string at position 4 could not be parsed: Unknown type name 'numeric-string' at position 4 in float|int|numeric-string.

     *
     * @return array{ 0: int, 1: string|null}

The doc comment array{ at position 2 could not be parsed: the token is null at position 2.

     *     Where `0` is the integer part and `1` the fractional part. The fractional part is `null` if
     *     `$number` has no decimal separator. The fractional part is returned as a string to preserve '03' from
     *     '1.03'.
     */
    public static function parse(float|int|string $number, ?int $precision = null): array
    {
        if ($precision === null) {
            $precision = self::precision_from($number);
        }

        $number = self::round_to($number + 0, $precision);
        $number = abs($number);
        $number = number_format($number, $precision, '.', '');

        [ $integer, $fractional ] = explode('.', (string)$number) + [ 1 => null ];

        return [ (int)$integer, $fractional ];
    }

    /**
     * @param float|int|numeric-string $number

The doc comment float|int|numeric-string at position 4 could not be parsed: Unknown type name 'numeric-string' at position 4 in float|int|numeric-string.

     *
     * @return float|int|numeric-string

The doc comment float|int|numeric-string at position 4 could not be parsed: Unknown type name 'numeric-string' at position 4 in float|int|numeric-string.

     */
    public static function expand_compact_decimal_exponent(float|int|string $number, int &$c = 0): float|int|string
    {
        $c = 0;

        if (!is_string($number)) {
            return $number;
        }

        $c_pos = strpos($number, 'c');

        if ($c_pos === false) {
            return $number;
        }

        $c = (int)substr($number, $c_pos + 1);
        $number = substr($number, 0, $c_pos);
        preg_match('/0+$/', $number, $match);
        assert(is_numeric($number));
        $multiplier = (int)('1' . str_repeat('0', $c));
        $number *= $multiplier;

        if ($match) {
            return $number . $match[0]; // @phpstan-ignore-line
        }

        return $number;
    }
}