MediaWiki master
PluralRules.php
Go to the documentation of this file.
1<?php
6
7namespace Wikimedia\Leximorph\Provider;
8
9use CLDRPluralRuleParser\Error as CLDRPluralRuleError;
10use CLDRPluralRuleParser\Evaluator;
11use Psr\Log\LoggerInterface;
12use RuntimeException;
13use Wikimedia\Leximorph\Provider;
14use Wikimedia\Leximorph\Util\XmlLoader;
15
26
30 public const array PLURAL_FILES = [
31 // Load CLDR plural rules
32 __DIR__ . '/../data/plurals.xml',
33 // Override or extend with MW-specific rules
34 __DIR__ . '/../data/plurals-mediawiki.xml',
35 ];
36
47 private static ?array $pluralData = null;
48
52 public function __construct(
53 private readonly string $langCode,
54 private readonly Evaluator $evaluator,
55 private readonly Provider $provider,
56 private readonly LoggerInterface $logger,
57 private readonly XmlLoader $xmlLoader,
58 ) {
59 }
60
67 public function getPluralRuleIndexNumber( float $number ): int {
68 $compiledRules = $this->getCompiledPluralRules();
69 $evaluatedNumber = ( $number == (int)$number ) ? (int)$number : (string)$number;
70
71 return $this->evaluator->evaluateCompiled( $evaluatedNumber, $compiledRules );
72 }
73
82 public function getCompiledPluralRules(): array {
83 $rules = $this->compileRulesFor( $this->langCode );
84 if ( count( $rules ) === 0 ) {
85 foreach ( $this->provider->getLanguageFallbacksProvider()->getFallbacks() as $fallbackCode ) {
86 $rules = $this->compileRulesFor( $fallbackCode );
87 if ( count( $rules ) > 0 ) {
88 break;
89 }
90 }
91 }
92
93 return $rules;
94 }
95
107 public function compileRulesFor( string $code ): array {
108 self::$pluralData ??= self::loadPluralFiles();
109 $data = self::$pluralData[$code] ?? null;
110 $rules = $data ? array_column( $data, 'rule' ) : null;
111
112 return $this->compileRulesFromArray( $rules );
113 }
114
121 private function loadPluralFiles(): array {
122 $pluralData = [];
123 foreach ( self::PLURAL_FILES as $fileName ) {
124 $pluralData = array_merge( $pluralData, $this->loadPluralFile( $fileName ) );
125 }
126
127 return $pluralData;
128 }
129
139 private function loadPluralFile( string $fileName ): array {
140 $data = [];
141
142 $doc = $this->xmlLoader->load( $fileName, 'PluralRules' );
143 if ( $doc === null ) {
144 return $data;
145 }
146
147 $rulesets = $doc->getElementsByTagName( "pluralRules" );
148 foreach ( $rulesets as $ruleset ) {
149 $codes = $ruleset->getAttribute( 'locales' );
150 $rules = [];
151 $ruleElements = $ruleset->getElementsByTagName( "pluralRule" );
152 foreach ( $ruleElements as $elt ) {
153 $ruleType = $elt->getAttribute( 'count' );
154 if ( $ruleType === 'other' ) {
155 // Skip "other" rules, which have an empty condition.
156 continue;
157 }
158 $rules[] = [
159 'type' => $ruleType,
160 'rule' => (string)$elt->nodeValue,
161 ];
162 }
163 foreach ( explode( ' ', $codes ) as $code ) {
164 $data[$code] = $rules;
165 }
166 }
167
168 return $data;
169 }
170
183 private function compileRulesFromArray( ?array $rules ): array {
184 if ( $rules === null ) {
185 return [];
186 }
187 try {
189 $compiled = $this->evaluator->compile( $rules );
190
191 return array_values( $compiled );
192 } catch ( CLDRPluralRuleError $e ) {
193 $this->logger->debug( 'Unable to compile rules', [ 'exception' => $e ] );
194
195 return [];
196 }
197 }
198
207 public function getPluralRules(): ?array {
208 self::$pluralData ??= self::loadPluralFiles();
209 $data = self::$pluralData[$this->langCode] ?? null;
210
211 return $data ? array_column( $data, 'rule' ) : null;
212 }
213
221 public function getPluralRuleType( float $number ): string {
222 $index = $this->getPluralRuleIndexNumber( $number );
223 $types = $this->getPluralRuleTypes();
224
225 return $types[$index] ?? 'other';
226 }
227
236 public function getPluralRuleTypes(): array {
237 self::$pluralData ??= self::loadPluralFiles();
238 $data = self::$pluralData[$this->langCode] ?? [];
239 if ( count( $data ) === 0 ) {
240 foreach ( $this->provider->getLanguageFallbacksProvider()->getFallbacks() as $fallbackCode ) {
241 $data = self::$pluralData[$fallbackCode] ?? [];
242 if ( count( $data ) > 0 ) {
243 break;
244 }
245 }
246 }
247
248 return array_column( $data, 'type' );
249 }
250}
if(!defined('MW_SETUP_CALLBACK'))
Definition WebStart.php:72
compileRulesFor(string $code)
Compiles the plural rules for the specified language code.
const array PLURAL_FILES
The paths to the plural rules XML files.
getPluralRuleTypes()
Returns the plural rule types for the current language from the XML files.
getPluralRuleType(float $number)
Finds the plural rule type corresponding to the given number.
getCompiledPluralRules()
Returns the compiled plural rules for the current language.
getPluralRules()
Returns the raw plural rules for the current language from the XML files.