eliashaeussler/typo3-badges

<?php

declare(strict_types=1);

/*
 * This file is part of the Symfony project "eliashaeussler/typo3-badges".
 *
 * Copyright (C) 2021-2024 Elias Häußler <elias@haeussler.dev>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */

namespace App\Value;

use function array_key_exists;
use function intval;

/**
 * NumberFormatter.
 *
 * @author Elias Häußler <elias@haeussler.dev>
 * @license GPL-3.0-or-later
 */
final class NumberFormatter
{
    /**
     * @see https://gist.github.com/gcphost/589d915e2c2f67270cc9bdade732b77f
     *
     * @return non-empty-string
     */
    public static function format(int $number): string
    {
        if ($number < 1000) {
            return (string) $number;
        }

        $unit = intval(log($number, 1000));
        $units = ['', 'K', 'M', 'B', 'T', 'Q'];

        if (array_key_exists($unit, $units)) {
            /** @var non-empty-string $formattedNumber */
            $formattedNumber = rtrim(number_format($number / 1000 ** $unit, 1), '.0');

            return $formattedNumber.$units[$unit];
        }

        return (string) $number;
    }
}