ICanBoogie / CLDR

src/Numbers/NumberFormatter.php

<?php

namespace ICanBoogie\CLDR\Numbers;

use ICanBoogie\CLDR\Core\Formatter;
use ICanBoogie\CLDR\Core\Locale;
use ICanBoogie\CLDR\Core\Localizable;

/**
 * A number formatter.
 *
 * @implements Localizable<NumberFormatter, NumberFormatterLocalized>
 */
final class NumberFormatter implements Formatter, Localizable
{
    /**
     * Formats a number with the specified pattern.
     *
     * Note, if the pattern contains '%', the number will be multiplied by 100 first. If the
     * pattern contains '‰', the number will be multiplied by 1000.
     *
     * @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.

     *     The number to format.
     * @param string|NumberPattern $pattern
     *     The pattern used to format the number.
     */
    public function format(
        float|int|string $number,
        NumberPattern|string $pattern,
        ?Symbols $symbols = null,
    ): string {
        if (!$pattern instanceof NumberPattern) {
            $pattern = NumberPattern::from($pattern);
        }

        $symbols = $symbols ?? Symbols::defaults();

        [ $integer, $decimal ] = $pattern->parse_number($number);

        $formatted_integer = $pattern->format_integer_with_group($integer, $symbols->group);
        $formatted_number = $pattern->format_integer_with_decimal($formatted_integer, $decimal, $symbols->decimal);

        if ($number < 0) {
            $number = $pattern->negative_prefix . $formatted_number . $pattern->negative_suffix;
        } else {
            $number = $pattern->positive_prefix . $formatted_number . $pattern->positive_suffix;
        }

        return strtr($number, [

            '%' => $symbols->percentSign,
            '‰' => $symbols->perMille,

        ]);
    }

    public function localized(Locale $locale): NumberFormatterLocalized
    {
        return new NumberFormatterLocalized($this, $locale);
    }
}