ICanBoogie / CLDR

src/Numbers/CurrencyLocalized.php

<?php

namespace ICanBoogie\CLDR\Numbers;

use ICanBoogie\CLDR\Core\Locale;
use ICanBoogie\CLDR\Core\LocalizedObjectWithFormatter;

/**
 * A localized currency.
 *
 * @extends LocalizedObjectWithFormatter<Currency, CurrencyFormatterLocalized>
 */
final class CurrencyLocalized extends LocalizedObjectWithFormatter
{
    /**
     * @var string The localized name of the currency.
     */
    public readonly string $name;

    /**
     * @var string The localized symbol of the currency.
     */
    public readonly string $symbol;

    public function __construct(object $target, Locale $locale)
    {
        $l = $locale['currencies'][$target->code];
        $this->name = $l['displayName'];

The property name is declared read-only in ICanBoogie\CLDR\Numbers\CurrencyLocalized.

        // Not all currencies have a symbol, we default to the currency code in those cases.
        $this->symbol = $l['symbol'] ?? $target->code;

The property symbol is declared read-only in ICanBoogie\CLDR\Numbers\CurrencyLocalized.

        parent::__construct($target, $locale, $locale->currency_formatter);
    }

    /**
     * Returns the localized name of the currency.
     *
     * @param int|null $count Used for pluralization.
     */
    public function name_for(?int $count = null): string
    {
        $offset = 'displayName';

        if ($count == 1) {
            $offset .= '-count-one';
        } elseif ($count) {

The expression $count of type integer|null is loosely compared to true; this is ambiguous if the integer can be 0. You might want to explicitly use !== null instead.

            $offset .= '-count-other';
        }

        return $this->locale['currencies'][$this->target->code][$offset];
    }

    /**
     * Formats currency using locale's conventions.
     *
     * @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 function format(
        float|int|string $number,
        string $pattern = CurrencyFormatterLocalized::PATTERN_STANDARD
    ): string {
        return $this->formatter->format($number, $this->target, $pattern);

The method format() does not exist on ICanBoogie\CLDR\Core\Formatter. Since it exists in all sub-types, consider adding an abstract or default implementation to ICanBoogie\CLDR\Core\Formatter.

    }
}