ICanBoogie / CLDR

src/Numbers/CurrencyFormatter.php

<?php

namespace ICanBoogie\CLDR\Numbers;

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

use function str_replace;

/**
 * A currency formatter.
 *
 * @implements Localizable<CurrencyFormatter, CurrencyFormatterLocalized>
 */
final class CurrencyFormatter implements Formatter, Localizable
{
    public const DEFAULT_CURRENCY_SYMBOL = '¤';

    public function __construct(
        private readonly NumberFormatter $number_formatter,
    ) {
    }

    /**
     * Formats a number with the specified pattern.
     *
     * @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 $currencySymbol = self::DEFAULT_CURRENCY_SYMBOL
    ): string {
        return str_replace(
            self::DEFAULT_CURRENCY_SYMBOL,
            $currencySymbol,
            $this->number_formatter->format($number, $pattern, $symbols)
        );
    }

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