Plural.php

Go to the documentation of this file.

<?php
namespace Wikimedia\Leximorph\Handler;
 
use Wikimedia\Leximorph\Provider;
 
class Plural {
 
    public function __construct(
        private readonly Provider $provider,
    ) {
    }
 
    public function process( float $count, array $forms ): string {
        // For "explicit" forms such as "0=No items", "1=One item", or "other=Items"
        // we’ll store them in an associative array if we parse them that way.
        $explicitForms = [];
 
        // For "default" (non-explicit) forms such as [ 'item', 'items' ],
        // we store them in a sequential array with integer keys.
        $defaultForms = [];
 
        // Separate explicit forms ("n=text") from default forms
        foreach ( $forms as $form ) {
            if ( str_contains( $form, '=' ) ) {
                [
                    $key,
                    $text,
                ] = explode( '=', $form, 2 );
                // If key is purely numeric AND matches $count, return immediately:
                if ( is_numeric( $key ) && (float)$key === $count ) {
                    return $text;
                }
                // Otherwise, treat it as an explicit string key
                $explicitForms[$key] = $text;
            } else {
                // Default form
                $defaultForms[] = $form;
            }
        }
 
        // Figure out the plural category: "one", "few", "other", etc.
        $pluralType = $this->provider->getPluralProvider()->getPluralRuleType( $count );
 
        // If we have an explicit form matching $pluralType` as a key, use it:
        // e.g., "one" => "Item", "other" => "Items"
        if ( array_key_exists( $pluralType, $explicitForms ) ) {
            return $explicitForms[$pluralType];
        }
 
        // Otherwise, fallback to the default forms (sequential)
        // If we find a default that exactly matches $pluralType as a string, use that:
        $foundKey = array_search( $pluralType, $defaultForms, true );
        if ( $foundKey !== false ) {
            return $defaultForms[$foundKey];
        }
 
        // Else, use the numeric index from the language’s plural rules
        // (e.g. 0 => singular form, 1 => plural form, etc.)
        if ( count( $defaultForms ) > 0 ) {
            $index = $this->provider->getPluralProvider()->getPluralRuleIndexNumber( $count );
            // Guard in case $index is out of range
            $index = min( $index, count( $defaultForms ) - 1 );
 
            return $defaultForms[$index];
        }
 
        // If no forms were provided at all, just return an empty string
        return '';
    }
}