/var/www/html/wp-includes/l10n/class-wp-translation-controller.php


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
<?php
/**
 * I18N: WP_Translation_Controller class.
 *
 * @package WordPress
 * @subpackage I18N
 * @since 6.5.0
 */

/**
 * Class WP_Translation_Controller.
 *
 * @since 6.5.0
 */
final class WP_Translation_Controller {
    
/**
     * Current locale.
     *
     * @since 6.5.0
     * @var string
     */
    
protected $current_locale 'en_US';

    
/**
     * Map of loaded translations per locale and text domain.
     *
     * [ Locale => [ Textdomain => [ ..., ... ] ] ]
     *
     * @since 6.5.0
     * @var array<string, array<string, WP_Translation_File[]>>
     */
    
protected $loaded_translations = array();

    
/**
     * List of loaded translation files.
     *
     * [ Filename => [ Locale => [ Textdomain => WP_Translation_File ] ] ]
     *
     * @since 6.5.0
     * @var array<string, array<string, array<string, WP_Translation_File|false>>>
     */
    
protected $loaded_files = array();

    
/**
     * Container for the main instance of the class.
     *
     * @since 6.5.0
     * @var WP_Translation_Controller|null
     */
    
private static $instance null;

    
/**
     * Utility method to retrieve the main instance of the class.
     *
     * The instance will be created if it does not exist yet.
     *
     * @since 6.5.0
     *
     * @return WP_Translation_Controller
     */
    
public static function get_instance(): WP_Translation_Controller {
        if ( 
null === self::$instance ) {
            
self::$instance = new self();
        }

        return 
self::$instance;
    }

    
/**
     * Returns the current locale.
     *
     * @since 6.5.0
     *
     * @return string Locale.
     */
    
public function get_locale(): string {
        return 
$this->current_locale;
    }

    
/**
     * Sets the current locale.
     *
     * @since 6.5.0
     *
     * @param string $locale Locale.
     */
    
public function set_localestring $locale ) {
        
$this->current_locale $locale;
    }

    
/**
     * Loads a translation file for a given text domain.
     *
     * @since 6.5.0
     *
     * @param string $translation_file Translation file.
     * @param string $textdomain       Optional. Text domain. Default 'default'.
     * @param string $locale           Optional. Locale. Default current locale.
     * @return bool True on success, false otherwise.
     */
    
public function load_filestring $translation_filestring $textdomain 'default', ?string $locale null ): bool {
        if ( 
null === $locale ) {
            
$locale $this->current_locale;
        }

        
$translation_file realpath$translation_file );

        if ( 
false === $translation_file ) {
            return 
false;
        }

        if (
            isset( 
$this->loaded_files$translation_file ][ $locale ][ $textdomain ] ) &&
            
false !== $this->loaded_files$translation_file ][ $locale ][ $textdomain ]
        ) {
            return 
null === $this->loaded_files$translation_file ][ $locale ][ $textdomain ]->error();
        }

        if (
            isset( 
$this->loaded_files$translation_file ][ $locale ] ) &&
            array() !== 
$this->loaded_files$translation_file ][ $locale ]
        ) {
            
$moe reset$this->loaded_files$translation_file ][ $locale ] );
        } else {
            
$moe WP_Translation_File::create$translation_file );
            if ( 
false === $moe || null !== $moe->error() ) {
                
$moe false;
            }
        }

        
$this->loaded_files$translation_file ][ $locale ][ $textdomain ] = $moe;

        if ( ! 
$moe instanceof WP_Translation_File ) {
            return 
false;
        }

        if ( ! isset( 
$this->loaded_translations$locale ][ $textdomain ] ) ) {
            
$this->loaded_translations$locale ][ $textdomain ] = array();
        }

        
$this->loaded_translations$locale ][ $textdomain ][] = $moe;

        return 
true;
    }

    
/**
     * Unloads a translation file for a given text domain.
     *
     * @since 6.5.0
     *
     * @param WP_Translation_File|string $file       Translation file instance or file name.
     * @param string                     $textdomain Optional. Text domain. Default 'default'.
     * @param string                     $locale     Optional. Locale. Defaults to all locales.
     * @return bool True on success, false otherwise.
     */
    
public function unload_file$filestring $textdomain 'default', ?string $locale null ): bool {
        if ( 
is_string$file ) ) {
            
$file realpath$file );
        }

        if ( 
null !== $locale ) {
            if ( isset( 
$this->loaded_translations$locale ][ $textdomain ] ) ) {
                foreach ( 
$this->loaded_translations$locale ][ $textdomain ] as $i => $moe ) {
                    if ( 
$file === $moe || $file === $moe->get_file() ) {
                        unset( 
$this->loaded_translations$locale ][ $textdomain ][ $i ] );
                        unset( 
$this->loaded_files$moe->get_file() ][ $locale ][ $textdomain ] );
                        return 
true;
                    }
                }
            }

            return 
true;
        }

        foreach ( 
$this->loaded_translations as $l => $domains ) {
            if ( ! isset( 
$domains$textdomain ] ) ) {
                continue;
            }

            foreach ( 
$domains$textdomain ] as $i => $moe ) {
                if ( 
$file === $moe || $file === $moe->get_file() ) {
                    unset( 
$this->loaded_translations$l ][ $textdomain ][ $i ] );
                    unset( 
$this->loaded_files$moe->get_file() ][ $l ][ $textdomain ] );
                    return 
true;
                }
            }
        }

        return 
false;
    }

    
/**
     * Unloads all translation files for a given text domain.
     *
     * @since 6.5.0
     *
     * @param string $textdomain Optional. Text domain. Default 'default'.
     * @param string $locale     Optional. Locale. Defaults to all locales.
     * @return bool True on success, false otherwise.
     */
    
public function unload_textdomainstring $textdomain 'default', ?string $locale null ): bool {
        
$unloaded false;

        if ( 
null !== $locale ) {
            if ( isset( 
$this->loaded_translations$locale ][ $textdomain ] ) ) {
                
$unloaded true;
                foreach ( 
$this->loaded_translations$locale ][ $textdomain ] as $moe ) {
                    unset( 
$this->loaded_files$moe->get_file() ][ $locale ][ $textdomain ] );
                }
            }

            unset( 
$this->loaded_translations$locale ][ $textdomain ] );

            return 
$unloaded;
        }

        foreach ( 
$this->loaded_translations as $l => $domains ) {
            if ( ! isset( 
$domains$textdomain ] ) ) {
                continue;
            }

            
$unloaded true;

            foreach ( 
$domains$textdomain ] as $moe ) {
                unset( 
$this->loaded_files$moe->get_file() ][ $l ][ $textdomain ] );
            }

            unset( 
$this->loaded_translations$l ][ $textdomain ] );
        }

        return 
$unloaded;
    }

    
/**
     * Determines whether translations are loaded for a given text domain.
     *
     * @since 6.5.0
     *
     * @param string $textdomain Optional. Text domain. Default 'default'.
     * @param string $locale     Optional. Locale. Default current locale.
     * @return bool True if there are any loaded translations, false otherwise.
     */
    
public function is_textdomain_loadedstring $textdomain 'default', ?string $locale null ): bool {
        if ( 
null === $locale ) {
            
$locale $this->current_locale;
        }

        return isset( 
$this->loaded_translations$locale ][ $textdomain ] ) &&
            array() !== 
$this->loaded_translations$locale ][ $textdomain ];
    }

    
/**
     * Translates a singular string.
     *
     * @since 6.5.0
     *
     * @param string $text       Text to translate.
     * @param string $context    Optional. Context for the string. Default empty string.
     * @param string $textdomain Optional. Text domain. Default 'default'.
     * @param string $locale     Optional. Locale. Default current locale.
     * @return string|false Translation on success, false otherwise.
     */
    
public function translatestring $textstring $context ''string $textdomain 'default', ?string $locale null ) {
        if ( 
'' !== $context ) {
            
$context .= "\4";
        }

        
$translation $this->locate_translation"{$context}{$text}"$textdomain$locale );

        if ( 
false === $translation ) {
            return 
false;
        }

        return 
$translation['entries'][0];
    }

    
/**
     * Translates plurals.
     *
     * Checks both singular+plural combinations as well as just singulars,
     * in case the translation file does not store the plural.
     *
     * @since 6.5.0
     *
     * @param array       $plurals {
     *     Pair of singular and plural translations.
     *
     *     @type string $0 Singular translation.
     *     @type string $1 Plural translation.
     * }
     * @param int         $number     Number of items.
     * @param string      $context    Optional. Context for the string. Default empty string.
     * @param string      $textdomain Optional. Text domain. Default 'default'.
     * @param string|null $locale     Optional. Locale. Default current locale.
     * @return string|false Translation on success, false otherwise.
     */
    
public function translate_plural( array $pluralsint $numberstring $context ''string $textdomain 'default', ?string $locale null ) {
        if ( 
'' !== $context ) {
            
$context .= "\4";
        }

        
$text        implode"\0"$plurals );
        
$translation $this->locate_translation"{$context}{$text}"$textdomain$locale );

        if ( 
false === $translation ) {
            
$text        $plurals[0];
            
$translation $this->locate_translation"{$context}{$text}"$textdomain$locale );

            if ( 
false === $translation ) {
                return 
false;
            }
        }

        
/** @var WP_Translation_File $source */
        
$source $translation['source'];
        
$num    $source->get_plural_form$number );

        
// See \Translations::translate_plural().
        
return $translation['entries'][ $num ] ?? $translation['entries'][0];
    }

    
/**
     * Returns all existing headers for a given text domain.
     *
     * @since 6.5.0
     *
     * @param string $textdomain Optional. Text domain. Default 'default'.
     * @return array<string, string> Headers.
     */
    
public function get_headersstring $textdomain 'default' ): array {
        if ( array() === 
$this->loaded_translations ) {
            return array();
        }

        
$headers = array();

        foreach ( 
$this->get_files$textdomain ) as $moe ) {
            foreach ( 
$moe->headers() as $header => $value ) {
                
$headers$this->normalize_header$header ) ] = $value;
            }
        }

        return 
$headers;
    }

    
/**
     * Normalizes header names to be capitalized.
     *
     * @since 6.5.0
     *
     * @param string $header Header name.
     * @return string Normalized header name.
     */
    
protected function normalize_headerstring $header ): string {
        
$parts explode'-'$header );
        
$parts array_map'ucfirst'$parts );
        return 
implode'-'$parts );
    }

    
/**
     * Returns all entries for a given text domain.
     *
     * @since 6.5.0
     *
     * @param string $textdomain Optional. Text domain. Default 'default'.
     * @return array<string, string> Entries.
     */
    
public function get_entriesstring $textdomain 'default' ): array {
        if ( array() === 
$this->loaded_translations ) {
            return array();
        }

        
$entries = array();

        foreach ( 
$this->get_files$textdomain ) as $moe ) {
            
$entries array_merge$entries$moe->entries() );
        }

        return 
$entries;
    }

    
/**
     * Locates translation for a given string and text domain.
     *
     * @since 6.5.0
     *
     * @param string $singular   Singular translation.
     * @param string $textdomain Optional. Text domain. Default 'default'.
     * @param string $locale     Optional. Locale. Default current locale.
     * @return array{source: WP_Translation_File, entries: string[]}|false {
     *     Translations on success, false otherwise.
     *
     *     @type WP_Translation_File $source Translation file instance.
     *     @type string[]            $entries Array of translation entries.
     * }
     */
    
protected function locate_translationstring $singularstring $textdomain 'default', ?string $locale null ) {
        if ( array() === 
$this->loaded_translations ) {
            return 
false;
        }

        
// Find the translation in all loaded files for this text domain.
        
foreach ( $this->get_files$textdomain$locale ) as $moe ) {
            
$translation $moe->translate$singular );
            if ( 
false !== $translation ) {
                return array(
                    
'entries' => explode"\0"$translation ),
                    
'source'  => $moe,
                );
            }
            if ( 
null !== $moe->error() ) {
                
// Unload this file, something is wrong.
                
$this->unload_file$moe$textdomain$locale );
            }
        }

        
// Nothing could be found.
        
return false;
    }

    
/**
     * Returns all translation files for a given text domain.
     *
     * @since 6.5.0
     *
     * @param string $textdomain Optional. Text domain. Default 'default'.
     * @param string $locale     Optional. Locale. Default current locale.
     * @return WP_Translation_File[] List of translation files.
     */
    
protected function get_filesstring $textdomain 'default', ?string $locale null ): array {
        if ( 
null === $locale ) {
            
$locale $this->current_locale;
        }

        return 
$this->loaded_translations$locale ][ $textdomain ] ?? array();
    }

    
/**
     * Returns a boolean to indicate whether a translation exists for a given string with optional text domain and locale.
     *
     * @since 6.7.0
     *
     * @param string  $singular   Singular translation to check.
     * @param string  $textdomain Optional. Text domain. Default 'default'.
     * @param ?string $locale     Optional. Locale. Default current locale.
     * @return bool  True if the translation exists, false otherwise.
     */
    
public function has_translationstring $singularstring $textdomain 'default', ?string $locale null ): bool {
        if ( 
null === $locale ) {
            
$locale $this->current_locale;
        }

        return 
false !== $this->locate_translation$singular$textdomain$locale );
    }
}