ICanBoogie / CLDR

src/Supplemental/Plurals.php

<?php

namespace ICanBoogie\CLDR\Supplemental;

use ArrayObject;
use ICanBoogie\CLDR\Supplemental\Plurals\Rule;
use ICanBoogie\CLDR\Supplemental\Plurals\Samples;

use function array_keys;
use function array_shift;
use function explode;
use function is_null;
use function strlen;
use function strpos;
use function substr;
use function trim;

/**
 * Representation of plurals
 *
 * @extends ArrayObject<string, array<string, string>>
 *     Where _key_ is a locale and _value_ a rule.
 */
final class Plurals extends ArrayObject
{
    public const COUNT_ZERO = 'zero';
    public const COUNT_ONE = 'one';
    public const COUNT_TWO = 'two';
    public const COUNT_FEW = 'few';
    public const COUNT_MANY = 'many';
    public const COUNT_OTHER = 'other';

    /**
     * @private
     */
    public const RULE_COUNT_PREFIX = 'pluralRule-count-';

    /**
     * @var array<string, array<self::COUNT_*, Rule>>

The doc comment array<string, array<self::COUNT_*, Rule>> at position 6 could not be parsed: Expected '>' at position 6, but found 'self'.

     *     Where _key_ is a locale code and _value_ an array where _key_ is a rule count.
     */
    private array $rules = [];

    /**
     * @var array<string, array<self::COUNT_*, Samples>>

The doc comment array<string, array<self::COUNT_*, Samples>> at position 6 could not be parsed: Expected '>' at position 6, but found 'self'.

     *     Where _key_ is a locale code and _value_ an array where _key_ is a rule count.
     */
    private array $samples = [];

    /**
     * @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.

     *
     * @return self::COUNT_*
     */
    public function rule_for(float|int|string $number, string $language): string
    {
        $rules = $this->rule_instances_for($language);

        foreach ($rules as $count => $rule) {
            if ($rule->validate($number)) {
                return $count;
            }
        }

        return self::COUNT_OTHER;
    }

    /**
     * @return array<self::COUNT_*>

The doc comment array<self::COUNT_*> at position 2 could not be parsed: Expected '>' at position 2, but found 'self'.

     */
    public function rules_for(string $locale): array
    {
        return array_keys($this->rule_instances_for($locale));
    }

    /**
     * @return array<self::COUNT_*, Samples>

The doc comment array<self::COUNT_*, Samples> at position 2 could not be parsed: Expected '>' at position 2, but found 'self'.

     */
    public function samples_for(string $locale): array
    {
        return $this->samples[$locale] ??= $this->create_samples_for($locale);
    }

    /**
     * @return array<self::COUNT_*, Rule>

The doc comment array<self::COUNT_*, Rule> at position 2 could not be parsed: Expected '>' at position 2, but found 'self'.

     */
    private function rule_instances_for(string $language): array
    {
        return $this->rules[$language] ??= $this->create_rules_for($language);
    }

    /**
     * @return array<self::COUNT_*, Rule>

The doc comment array<self::COUNT_*, Rule> at position 2 could not be parsed: Expected '>' at position 2, but found 'self'.

     */
    private function create_rules_for(string $language): array
    {
        $rules = [];
        $prefix_length = strlen(self::RULE_COUNT_PREFIX);

        /** @phpstan-ignore-next-line */
        foreach ($this[$language] as $count => $rule_string) {
            $count = substr($count, $prefix_length);
            $rules[$count] = Rule::from($this->extract_rule($rule_string));
        }

        /** @var array<self::COUNT_*, Rule> */
        return $rules;
    }

    private function extract_rule(string $rule_string): string
    {
        $rule = explode('@', $rule_string, 2);
        $rule = array_shift($rule);

        return trim($rule);
    }

    /**
     * @return array<self::COUNT_*, Samples>

The doc comment array<self::COUNT_*, Samples> at position 2 could not be parsed: Expected '>' at position 2, but found 'self'.

     */
    private function create_samples_for(string $locale): array
    {
        $samples = [];
        $prefix_length = strlen(self::RULE_COUNT_PREFIX);
        $rules = $this[$locale];

        assert(!is_null($rules));

        foreach ($rules as $count => $rule_string) {
            $count = substr($count, $prefix_length);
            $samples[$count] = Samples::from($this->extract_samples($rule_string));
        }

        /** @var array<self::COUNT_*, Samples> */
        return $samples;
    }

    private function extract_samples(string $rule_string): string
    {
        $pos = strpos($rule_string, '@');

        if ($pos === false) {
            return "";
        }

        return substr($rule_string, $pos);
    }
}