Localize numeric value using encapsulated NumberFormatter functions

numeric_format.php

<?php
/**
 * Localize numeric value using encapsulated NumberFormatter functions
 *
 * @param float $amount
 * @param array $kwargs
 * @link https://www.php.net/manual/en/numberformatter.format.php
 * @link https://www.php.net/manual/en/numberformatter.create.php
 * @link https://www.php.net/manual/en/class.locale.php
 * @return string|false
 */
function numeric_format($number, array $kwargs = []) {
    extract($kwargs + [
        'locale'  => substr(Locale::getDefault(), 0, 5) ?: NULL,
        'pattern' => NULL,
        'style'   => NumberFormatter::DEFAULT_STYLE,
        'type'    => NumberFormatter::TYPE_DEFAULT,
    ]);
    $fmt = numfmt_create($locale, $style, $pattern);
    return numfmt_format($fmt, $number, $type);
}

/**
 * Variants
 */

function spellout_format($number, array $kwargs = []) {
    $kwargs['style'] = NumberFormatter::SPELLOUT;
    return numeric_format($number, $kwargs);
}
function ordinal_format($number, array $kwargs = []) {
    $kwargs['style'] = NumberFormatter::ORDINAL;
    return numeric_format($number, $kwargs);
}

numfmt_create() arguments

• https://www.php.net/manual/en/numberformatter.create.php

numfmt_create(string $locale, int $style, ?string $pattern = null): ?NumberFormatter

$locale

• https://www.php.net/manual/en/function.setlocale

If NULL, it will lookup its default value in this order:

1. ini_get('intl.default_locale')
2. setlocale(LC_ALL, '0');
3. $LANG value from the set locale of the operating system.

$style

• https://www.php.net/manual/en/class.numberformatter.php#intl.numberformatter-constants.unumberformatstyle

• The numeric default is NumberFormatter::DEFAULT_STYLE.

$pattern

• https://unicode.org/reports/tr35/tr35-numbers.html#table-number-pattern-character-definitions

• If not NULL, it will override the style argument.

• If NULL, it will defer to the style argument.