Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
78.03% covered (warning)
78.03%
1520 / 1948
35.90% covered (danger)
35.90%
56 / 156
CRAP
0.00% covered (danger)
0.00%
0 / 1
Language
78.07% covered (warning)
78.07%
1520 / 1947
35.90% covered (danger)
35.90%
56 / 156
7127.98
0.00% covered (danger)
0.00%
0 / 1
 __construct
100.00% covered (success)
100.00%
9 / 9
100.00% covered (success)
100.00%
1 / 1
1
 getFallbackLanguages
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 getBookstoreList
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 getNamespaces
95.00% covered (success)
95.00%
19 / 20
0.00% covered (danger)
0.00%
0 / 1
5
 setNamespaces
0.00% covered (danger)
0.00%
0 / 2
0.00% covered (danger)
0.00%
0 / 1
2
 resetNamespaces
0.00% covered (danger)
0.00%
0 / 3
0.00% covered (danger)
0.00%
0 / 1
2
 getFormattedNamespaces
0.00% covered (danger)
0.00%
0 / 4
0.00% covered (danger)
0.00%
0 / 1
6
 getNsText
100.00% covered (success)
100.00%
2 / 2
100.00% covered (success)
100.00%
1 / 1
1
 getFormattedNsText
100.00% covered (success)
100.00%
2 / 2
100.00% covered (success)
100.00%
1 / 1
2
 getGenderNsText
0.00% covered (danger)
0.00%
0 / 4
0.00% covered (danger)
0.00%
0 / 1
2
 needsGenderDistinction
75.00% covered (warning)
75.00%
6 / 8
0.00% covered (danger)
0.00%
0 / 1
4.25
 getLocalNsIndex
0.00% covered (danger)
0.00%
0 / 3
0.00% covered (danger)
0.00%
0 / 1
2
 getNamespaceAliases
90.00% covered (success)
90.00%
27 / 30
0.00% covered (danger)
0.00%
0 / 1
10.10
 getNamespaceIds
0.00% covered (danger)
0.00%
0 / 7
0.00% covered (danger)
0.00%
0 / 1
20
 getNsIndex
0.00% covered (danger)
0.00%
0 / 6
0.00% covered (danger)
0.00%
0 / 1
6
 getVariantname
0.00% covered (danger)
0.00%
0 / 8
0.00% covered (danger)
0.00%
0 / 1
20
 getDatePreferences
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 getDateFormats
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 getDefaultDateFormat
75.00% covered (warning)
75.00%
3 / 4
0.00% covered (danger)
0.00%
0 / 1
3.14
 getDatePreferenceMigrationMap
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 getMessageFromDB
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 msg
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 getMonthName
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 getMonthNamesArray
0.00% covered (danger)
0.00%
0 / 4
0.00% covered (danger)
0.00%
0 / 1
6
 getMonthNameGen
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 getMonthAbbreviation
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 getMonthAbbreviationsArray
0.00% covered (danger)
0.00%
0 / 4
0.00% covered (danger)
0.00%
0 / 1
6
 getWeekdayName
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 getWeekdayAbbreviation
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 dateTimeObj
100.00% covered (success)
100.00%
5 / 5
100.00% covered (success)
100.00%
1 / 1
3
 dateTimeObjFormat
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 sprintfDate
93.26% covered (success)
93.26%
346 / 371
0.00% covered (danger)
0.00%
0 / 1
139.49
 computeUnitTimestampDeadline
93.33% covered (success)
93.33%
28 / 30
0.00% covered (danger)
0.00%
0 / 1
9.02
 tsToIranian
96.15% covered (success)
96.15%
25 / 26
0.00% covered (danger)
0.00%
0 / 1
9
 tsToHijri
92.31% covered (success)
92.31%
24 / 26
0.00% covered (danger)
0.00%
0 / 1
7.02
 tsToHebrew
59.65% covered (warning)
59.65%
34 / 57
0.00% covered (danger)
0.00%
0 / 1
79.51
 hebrewYearStart
77.78% covered (warning)
77.78%
14 / 18
0.00% covered (danger)
0.00%
0 / 1
13.58
 tsToYear
69.23% covered (warning)
69.23%
9 / 13
0.00% covered (danger)
0.00%
0 / 1
8.43
 tsToJapaneseGengo
100.00% covered (success)
100.00%
13 / 13
100.00% covered (success)
100.00%
1 / 1
10
 tsToJapaneseGengoCalculate
100.00% covered (success)
100.00%
4 / 4
100.00% covered (success)
100.00%
1 / 1
2
 strongDirFromContent
100.00% covered (success)
100.00%
5 / 5
100.00% covered (success)
100.00%
1 / 1
3
 romanNumeral
93.75% covered (success)
93.75%
15 / 16
0.00% covered (danger)
0.00%
0 / 1
5.01
 hebrewNumeral
100.00% covered (success)
100.00%
50 / 50
100.00% covered (success)
100.00%
1 / 1
13
 userAdjust
73.68% covered (warning)
73.68%
14 / 19
0.00% covered (danger)
0.00%
0 / 1
4.29
 convertDateFormatToJs
76.67% covered (warning)
76.67%
184 / 240
0.00% covered (danger)
0.00%
0 / 1
155.29
 makeMediaWikiTimestamp
0.00% covered (danger)
0.00%
0 / 2
0.00% covered (danger)
0.00%
0 / 1
6
 dateFormat
63.64% covered (warning)
63.64%
7 / 11
0.00% covered (danger)
0.00%
0 / 1
4.77
 getDateFormatString
73.33% covered (warning)
73.33%
11 / 15
0.00% covered (danger)
0.00%
0 / 1
7.93
 date
0.00% covered (danger)
0.00%
0 / 5
0.00% covered (danger)
0.00%
0 / 1
6
 time
0.00% covered (danger)
0.00%
0 / 5
0.00% covered (danger)
0.00%
0 / 1
6
 timeanddate
80.00% covered (warning)
80.00%
4 / 5
0.00% covered (danger)
0.00%
0 / 1
2.03
 formatDuration
100.00% covered (success)
100.00%
6 / 6
100.00% covered (success)
100.00%
1 / 1
2
 formatDurationBetweenTimestamps
100.00% covered (success)
100.00%
39 / 39
100.00% covered (success)
100.00%
1 / 1
11
 getDurationIntervals
100.00% covered (success)
100.00%
22 / 22
100.00% covered (success)
100.00%
1 / 1
6
 internalUserTimeAndDate
0.00% covered (danger)
0.00%
0 / 17
0.00% covered (danger)
0.00%
0 / 1
20
 userDate
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 userTime
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 userTimeAndDate
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 getHumanTimestamp
92.86% covered (success)
92.86%
13 / 14
0.00% covered (danger)
0.00%
0 / 1
3.00
 getHumanTimestampInternal
89.47% covered (warning)
89.47%
34 / 38
0.00% covered (danger)
0.00%
0 / 1
20.47
 getGroupName
100.00% covered (success)
100.00%
2 / 2
100.00% covered (success)
100.00%
1 / 1
2
 getGroupMemberName
100.00% covered (success)
100.00%
4 / 4
100.00% covered (success)
100.00%
1 / 1
3
 getMessage
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 getAllMessages
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 iconv
0.00% covered (danger)
0.00%
0 / 4
0.00% covered (danger)
0.00%
0 / 1
2
 ucfirst
87.50% covered (warning)
87.50%
14 / 16
0.00% covered (danger)
0.00%
0 / 1
6.07
 uc
0.00% covered (danger)
0.00%
0 / 3
0.00% covered (danger)
0.00%
0 / 1
12
 lcfirst
83.33% covered (warning)
83.33%
10 / 12
0.00% covered (danger)
0.00%
0 / 1
5.12
 lc
66.67% covered (warning)
66.67%
2 / 3
0.00% covered (danger)
0.00%
0 / 1
3.33
 isMultibyte
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 ucwords
100.00% covered (success)
100.00%
11 / 11
100.00% covered (success)
100.00%
1 / 1
2
 ucwordbreaks
100.00% covered (success)
100.00%
19 / 19
100.00% covered (success)
100.00%
1 / 1
2
 caseFold
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 checkTitleEncoding
66.67% covered (warning)
66.67%
2 / 3
0.00% covered (danger)
0.00%
0 / 1
2.15
 fallback8bitEncoding
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 hasWordBreaks
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 segmentByWord
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 getSearchIndexVariant
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 normalizeForSearch
75.00% covered (warning)
75.00%
3 / 4
0.00% covered (danger)
0.00%
0 / 1
2.06
 convertDoubleWidth
100.00% covered (success)
100.00%
6 / 6
100.00% covered (success)
100.00%
1 / 1
1
 insertSpace
0.00% covered (danger)
0.00%
0 / 2
0.00% covered (danger)
0.00%
0 / 1
2
 convertForSearchResult
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 firstChar
42.42% covered (danger)
42.42%
14 / 33
0.00% covered (danger)
0.00%
0 / 1
79.84
 normalize
66.67% covered (warning)
66.67%
4 / 6
0.00% covered (danger)
0.00%
0 / 1
2.15
 transformUsingPairFile
0.00% covered (danger)
0.00%
0 / 3
0.00% covered (danger)
0.00%
0 / 1
6
 isRTL
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 getDir
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
6
 alignStart
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
6
 alignEnd
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
6
 getDirMarkEntity
0.00% covered (danger)
0.00%
0 / 4
0.00% covered (danger)
0.00%
0 / 1
20
 getDirMark
0.00% covered (danger)
0.00%
0 / 3
0.00% covered (danger)
0.00%
0 / 1
20
 getArrow
0.00% covered (danger)
0.00%
0 / 12
0.00% covered (danger)
0.00%
0 / 1
90
 linkPrefixExtension
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 getMagicWords
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 getMagic
83.33% covered (warning)
83.33%
5 / 6
0.00% covered (danger)
0.00%
0 / 1
2.02
 getSpecialPageAliases
0.00% covered (danger)
0.00%
0 / 3
0.00% covered (danger)
0.00%
0 / 1
2
 emphasize
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 formatNum
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 formatNumInternal
98.15% covered (success)
98.15%
53 / 54
0.00% covered (danger)
0.00%
0 / 1
17
 formatNumNoSeparators
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 parseFormattedNumber
100.00% covered (success)
100.00%
16 / 16
100.00% covered (success)
100.00%
1 / 1
6
 digitGroupingPattern
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 digitTransformTable
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 separatorTransformTable
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 minimumGroupingDigits
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 listToText
100.00% covered (success)
100.00%
12 / 12
100.00% covered (success)
100.00%
1 / 1
4
 commaList
0.00% covered (danger)
0.00%
0 / 4
0.00% covered (danger)
0.00%
0 / 1
2
 semicolonList
0.00% covered (danger)
0.00%
0 / 4
0.00% covered (danger)
0.00%
0 / 1
2
 pipeList
0.00% covered (danger)
0.00%
0 / 4
0.00% covered (danger)
0.00%
0 / 1
2
 truncateForDatabase
100.00% covered (success)
100.00%
3 / 3
100.00% covered (success)
100.00%
1 / 1
1
 truncateForVisual
100.00% covered (success)
100.00%
3 / 3
100.00% covered (success)
100.00%
1 / 1
1
 truncateInternal
95.00% covered (success)
95.00%
19 / 20
0.00% covered (danger)
0.00%
0 / 1
9
 removeBadCharLast
80.00% covered (warning)
80.00%
8 / 10
0.00% covered (danger)
0.00%
0 / 1
5.20
 truncateHtml
97.06% covered (success)
97.06%
66 / 68
0.00% covered (danger)
0.00%
0 / 1
29
 truncate_skip
100.00% covered (success)
100.00%
9 / 9
100.00% covered (success)
100.00%
1 / 1
4
 truncate_endBracket
100.00% covered (success)
100.00%
8 / 8
100.00% covered (success)
100.00%
1 / 1
7
 convertGrammar
79.17% covered (warning)
79.17%
19 / 24
0.00% covered (danger)
0.00%
0 / 1
8.58
 getGrammarForms
0.00% covered (danger)
0.00%
0 / 5
0.00% covered (danger)
0.00%
0 / 1
12
 getGrammarTransformations
88.89% covered (warning)
88.89%
8 / 9
0.00% covered (danger)
0.00%
0 / 1
4.02
 gender
0.00% covered (danger)
0.00%
0 / 8
0.00% covered (danger)
0.00%
0 / 1
20
 convertPlural
100.00% covered (success)
100.00%
8 / 8
100.00% covered (success)
100.00%
1 / 1
3
 handleExplicitPluralForms
100.00% covered (success)
100.00%
7 / 7
100.00% covered (success)
100.00%
1 / 1
4
 preConvertPlural
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 getFormalityIndex
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 embedBidi
100.00% covered (success)
100.00%
6 / 6
100.00% covered (success)
100.00%
1 / 1
3
 getBlockDurations
85.71% covered (warning)
85.71%
6 / 7
0.00% covered (danger)
0.00%
0 / 1
4.05
 translateBlockExpiry
95.24% covered (success)
95.24%
20 / 21
0.00% covered (danger)
0.00%
0 / 1
10
 segmentForDiff
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 unsegmentForDiff
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 linkTrail
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 linkPrefixCharset
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 equals
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
2
 getCode
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 getHtmlCode
100.00% covered (success)
100.00%
2 / 2
100.00% covered (success)
100.00%
1 / 1
1
 toBcp47Code
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 isSameCodeAs
60.00% covered (warning)
60.00%
3 / 5
0.00% covered (danger)
0.00%
0 / 1
3.58
 getCodeFromFileName
0.00% covered (danger)
0.00%
0 / 6
0.00% covered (danger)
0.00%
0 / 1
6
 fixVariableInNamespace
100.00% covered (success)
100.00%
11 / 11
100.00% covered (success)
100.00%
1 / 1
2
 formatExpiry
0.00% covered (danger)
0.00%
0 / 13
0.00% covered (danger)
0.00%
0 / 1
56
 formatTimePeriod
100.00% covered (success)
100.00%
73 / 73
100.00% covered (success)
100.00%
1 / 1
23
 formatBitrate
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 formatComputingNumbers
100.00% covered (success)
100.00%
17 / 17
100.00% covered (success)
100.00%
1 / 1
5
 formatSize
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 specialList
0.00% covered (danger)
0.00%
0 / 5
0.00% covered (danger)
0.00%
0 / 1
6
 getNumberFormatter
52.63% covered (warning)
52.63%
10 / 19
0.00% covered (danger)
0.00%
0 / 1
14.80
 createNumberFormatter
57.14% covered (warning)
57.14%
4 / 7
0.00% covered (danger)
0.00%
0 / 1
3.71
 getCompiledPluralRules
40.00% covered (danger)
40.00%
4 / 10
0.00% covered (danger)
0.00%
0 / 1
7.46
 getPluralRules
0.00% covered (danger)
0.00%
0 / 10
0.00% covered (danger)
0.00%
0 / 1
20
 getPluralRuleTypes
0.00% covered (danger)
0.00%
0 / 10
0.00% covered (danger)
0.00%
0 / 1
20
 getPluralRuleIndexNumber
100.00% covered (success)
100.00%
2 / 2
100.00% covered (success)
100.00%
1 / 1
1
 getPluralRuleType
100.00% covered (success)
100.00%
3 / 3
100.00% covered (success)
100.00%
1 / 1
1
 getConverterInternal
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 getHookContainer
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 getHookRunner
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 getJsData
0.00% covered (danger)
0.00%
0 / 12
0.00% covered (danger)
0.00%
0 / 1
2
 getJsDateFormats
86.21% covered (warning)
86.21%
25 / 29
0.00% covered (danger)
0.00%
0 / 1
10.26
1<?php
2/**
3 * @license GPL-2.0-or-later
4 * @file
5 */
6
7/**
8 * @defgroup Language Internationalisation
9 *
10 * See https://www.mediawiki.org/wiki/Special:MyLanguage/Localisation for more information.
11 */
12
13/**
14 * @defgroup Languages Languages
15 * @ingroup Language
16 */
17
18namespace MediaWiki\Language;
19
20use CLDRPluralRuleParser\Evaluator;
21use DateTime;
22use DateTimeImmutable;
23use DateTimeInterface;
24use DateTimeZone;
25use InvalidArgumentException;
26use Locale;
27use LocalisationCache;
28use MediaWiki\Config\Config;
29use MediaWiki\Context\RequestContext;
30use MediaWiki\HookContainer\HookContainer;
31use MediaWiki\HookContainer\HookRunner;
32use MediaWiki\Html\Html;
33use MediaWiki\Json\FormatJson;
34use MediaWiki\Languages\Data\NormalizeAr;
35use MediaWiki\Languages\Data\NormalizeMl;
36use MediaWiki\Languages\LanguageConverterFactory;
37use MediaWiki\Languages\LanguageFallback;
38use MediaWiki\Languages\LanguageNameUtils;
39use MediaWiki\Logger\LoggerFactory;
40use MediaWiki\MainConfigNames;
41use MediaWiki\MediaWikiServices;
42use MediaWiki\Message\Message;
43use MediaWiki\Parser\MagicWord;
44use MediaWiki\Title\NamespaceInfo;
45use MediaWiki\User\User;
46use MediaWiki\User\UserIdentity;
47use MediaWiki\User\UserTimeCorrection;
48use MediaWiki\Utils\MWTimestamp;
49use MediaWiki\Xml\XmlSelect;
50use NumberFormatter;
51use RuntimeException;
52use UtfNormal\Validator as UtfNormalValidator;
53use Wikimedia\AtEase\AtEase;
54use Wikimedia\Bcp47Code\Bcp47Code;
55use Wikimedia\DebugInfo\DebugInfoTrait;
56use Wikimedia\Message\MessageParam;
57use Wikimedia\Message\MessageSpecifier;
58use Wikimedia\ReplacementArray;
59use Wikimedia\StringUtils\StringUtils;
60use Wikimedia\Timestamp\ConvertibleTimestamp;
61use Wikimedia\Timestamp\TimestampFormat as TS;
62
63/**
64 * Base class for language-specific code.
65 *
66 * See https://www.mediawiki.org/wiki/Special:MyLanguage/Localisation for more information.
67 *
68 * @ingroup Language
69 */
70class Language implements Bcp47Code {
71    use DebugInfoTrait;
72
73    /** @var string */
74    public $mCode;
75
76    /**
77     * @deprecated since 1.35, use LocalisationCache with custom language config
78     */
79    public $mMagicExtensions = [];
80
81    /** @var string|null */
82    private $mHtmlCode = null;
83
84    /**
85     * memoize
86     * @var string[][]
87     * @deprecated since 1.35, must be private
88     */
89    public $dateFormatStrings = [];
90
91    /**
92     * memoize
93     * @var string[][]|null
94     * @deprecated since 1.35, must be protected
95     */
96    public $mExtendedSpecialPageAliases;
97
98    /** @var array<int,string>|null Indexed by numeric namespace ID */
99    protected $namespaceNames;
100    /** @var array<string,int>|null Indexed by localized lower-cased namespace name */
101    protected $mNamespaceIds;
102    /** @var array<string,int>|null Map from alias to namespace ID */
103    protected $namespaceAliases;
104
105    /**
106     * @var ReplacementArray[]
107     * @noVarDump
108     */
109    private $transformData = [];
110
111    /**
112     * @var NamespaceInfo
113     * @noVarDump
114     */
115    private $namespaceInfo;
116
117    /**
118     * @var LocalisationCache
119     * @noVarDump
120     */
121    private $localisationCache;
122
123    /**
124     * @var LanguageNameUtils
125     * @noVarDump
126     */
127    private $langNameUtils;
128
129    /**
130     * @var LanguageFallback
131     * @noVarDump
132     */
133    private $langFallback;
134
135    /**
136     * @var array[]|null
137     * @noVarDump
138     */
139    private $grammarTransformCache;
140
141    /**
142     * @var LanguageConverterFactory
143     * @noVarDump
144     */
145    private $converterFactory;
146
147    /**
148     * @var HookContainer
149     * @noVarDump
150     */
151    private $hookContainer;
152
153    /**
154     * @var HookRunner
155     * @noVarDump
156     */
157    private $hookRunner;
158
159    /**
160     * @var Config
161     * @noVarDump
162     */
163    private $config;
164
165    /**
166     * @var array|null
167     */
168    private $overrideUcfirstCharacters;
169
170    /**
171     * @var NumberFormatter|null
172     * @noVarDump
173     */
174    private $numberFormatter = null;
175
176    /**
177     * @since 1.35
178     */
179    public const WEEKDAY_MESSAGES = [
180        'sunday', 'monday', 'tuesday', 'wednesday', 'thursday',
181        'friday', 'saturday'
182    ];
183
184    /**
185     * @since 1.35
186     */
187    public const WEEKDAY_ABBREVIATED_MESSAGES = [
188        'sun', 'mon', 'tue', 'wed', 'thu', 'fri', 'sat'
189    ];
190
191    /**
192     * @since 1.35
193     */
194    public const MONTH_MESSAGES = [
195        'january', 'february', 'march', 'april', 'may_long', 'june',
196        'july', 'august', 'september', 'october', 'november',
197        'december'
198    ];
199
200    /**
201     * @deprecated since 1.35, use the MONTH_MESSAGES constant
202     */
203    public static $mMonthMsgs = self::MONTH_MESSAGES;
204
205    /**
206     * @since 1.35
207     */
208    public const MONTH_GENITIVE_MESSAGES = [
209        'january-gen', 'february-gen', 'march-gen', 'april-gen', 'may-gen', 'june-gen',
210        'july-gen', 'august-gen', 'september-gen', 'october-gen', 'november-gen',
211        'december-gen'
212    ];
213
214    /**
215     * @since 1.35
216     */
217    public const MONTH_ABBREVIATED_MESSAGES = [
218        'jan', 'feb', 'mar', 'apr', 'may', 'jun', 'jul', 'aug',
219        'sep', 'oct', 'nov', 'dec'
220    ];
221
222    /**
223     * @deprecated since 1.35, use the MONTH_ABBREVIATED_MESSAGES constant
224     */
225    public static $mMonthAbbrevMsgs = self::MONTH_ABBREVIATED_MESSAGES;
226
227    /**
228     * @since 1.35
229     */
230    public const IRANIAN_CALENDAR_MONTHS_MESSAGES = [
231        'iranian-calendar-m1', 'iranian-calendar-m2', 'iranian-calendar-m3',
232        'iranian-calendar-m4', 'iranian-calendar-m5', 'iranian-calendar-m6',
233        'iranian-calendar-m7', 'iranian-calendar-m8', 'iranian-calendar-m9',
234        'iranian-calendar-m10', 'iranian-calendar-m11', 'iranian-calendar-m12'
235    ];
236
237    /**
238     * @since 1.35
239     */
240    public const HEBREW_CALENDAR_MONTHS_MESSAGES = [
241        'hebrew-calendar-m1', 'hebrew-calendar-m2', 'hebrew-calendar-m3',
242        'hebrew-calendar-m4', 'hebrew-calendar-m5', 'hebrew-calendar-m6',
243        'hebrew-calendar-m7', 'hebrew-calendar-m8', 'hebrew-calendar-m9',
244        'hebrew-calendar-m10', 'hebrew-calendar-m11', 'hebrew-calendar-m12',
245        'hebrew-calendar-m6a', 'hebrew-calendar-m6b'
246    ];
247
248    /**
249     * @since 1.35
250     */
251    public const HEBREW_CALENDAR_MONTH_GENITIVE_MESSAGES = [
252        'hebrew-calendar-m1-gen', 'hebrew-calendar-m2-gen', 'hebrew-calendar-m3-gen',
253        'hebrew-calendar-m4-gen', 'hebrew-calendar-m5-gen', 'hebrew-calendar-m6-gen',
254        'hebrew-calendar-m7-gen', 'hebrew-calendar-m8-gen', 'hebrew-calendar-m9-gen',
255        'hebrew-calendar-m10-gen', 'hebrew-calendar-m11-gen', 'hebrew-calendar-m12-gen',
256        'hebrew-calendar-m6a-gen', 'hebrew-calendar-m6b-gen'
257    ];
258
259    /**
260     * @since 1.35
261     */
262    public const HIJRI_CALENDAR_MONTH_MESSAGES = [
263        'hijri-calendar-m1', 'hijri-calendar-m2', 'hijri-calendar-m3',
264        'hijri-calendar-m4', 'hijri-calendar-m5', 'hijri-calendar-m6',
265        'hijri-calendar-m7', 'hijri-calendar-m8', 'hijri-calendar-m9',
266        'hijri-calendar-m10', 'hijri-calendar-m11', 'hijri-calendar-m12'
267    ];
268
269    /**
270     * @since 1.35
271     */
272    protected const DURATION_INTERVALS = [
273        'millennia' => 1000 * 31_556_952,
274        'centuries' => 100 * 31_556_952,
275        'decades' => 10 * 31_556_952,
276        // The average year is 365.2425 days (365 + (24 * 3 + 25) / 400)
277        'years' => 31_556_952, // 365.2425 * 24 * 3600
278        // To simplify, we consider a month to be 1/12 of a year
279        'months' => 365.2425 * 24 * 3600 / 12,
280        'days' => 24 * 3600,
281        'hours' => 3600,
282        'minutes' => 60,
283        'seconds' => 1,
284    ];
285
286    /**
287     * @deprecated since 1.35, use the DURATION_INTERVALS constant
288     * @since 1.20
289     * @var int[]
290     */
291    public static $durationIntervals = self::DURATION_INTERVALS;
292
293    /** Map of (time unit => relative datetime specifier) */
294    private const DEADLINE_DATE_SPEC_BY_UNIT = [
295        'Y' => 'first day of January next year midnight',
296        'M' => 'first day of next month midnight',
297        'W' => 'monday next week midnight',
298        'D' => 'next day midnight',
299        // Note that this may be before the current time, in which case
300        // we advance by a calendar year; the ISOY is actually 1 week past
301        // this, since dec 28 is always in "the last week of the ISO year".
302        'ISOY' => 'december 28 midnight',
303        // Note that this may be before the current time, in which case 'D'
304        // is used.
305        'AM' => 'today noon',
306        // Note that this relative datetime specifier does not zero out
307        // minutes/seconds, but we will do so manually in
308        // ::computeUnitTimestampDeadline() when given the unit 'H'/'m'/'s'
309        'H' => 'next hour',
310        'm' => 'next minute',
311        's' => 'next second',
312    ];
313
314    /**
315     * Unicode directional formatting characters
316     */
317    private const LRM = "\u{200E}"; // U+200E LEFT-TO-RIGHT MARK
318    private const RLM = "\u{200F}"; // U+200F RIGHT-TO-LEFT MARK
319    private const LRE = "\u{202A}"; // U+202A LEFT-TO-RIGHT EMBEDDING
320    private const RLE = "\u{202B}"; // U+202B RIGHT-TO-LEFT EMBEDDING
321    private const PDF = "\u{202C}"; // U+202C POP DIRECTIONAL FORMATTING
322    // https://en.wikipedia.org/wiki/Arabic_letter_mark (Unicode 6.3.0)
323    private const ALM = "\u{061C}"; // U+061C ARABIC LETTER MARK
324
325    /**
326     * Directionality test regex for embedBidi(). Matches the first strong directionality codepoint:
327     * - in group 1 if it is LTR
328     * - in group 2 if it is RTL
329     * Does not match if there is no strong directionality codepoint.
330     *
331     * The form is '/(?:([strong ltr codepoint])|([strong rtl codepoint]))/u'.
332     *
333     * Generated by UnicodeJS (see tools/strongDir) from the UCD; see
334     * https://gerrit.wikimedia.org/g/unicodejs .
335     * @var string
336     */
337    // @codeCoverageIgnoreStart
338    // phpcs:ignore Generic.Files.LineLength,MediaWiki.Commenting.PropertyDocumentation.MissingDocumentationPrivate
339    private static $strongDirRegex = '/(?:([\x{41}-\x{5a}\x{61}-\x{7a}\x{aa}\x{b5}\x{ba}\x{c0}-\x{d6}\x{d8}-\x{f6}\x{f8}-\x{2b8}\x{2bb}-\x{2c1}\x{2d0}\x{2d1}\x{2e0}-\x{2e4}\x{2ee}\x{370}-\x{373}\x{376}\x{377}\x{37a}-\x{37d}\x{37f}\x{386}\x{388}-\x{38a}\x{38c}\x{38e}-\x{3a1}\x{3a3}-\x{3f5}\x{3f7}-\x{482}\x{48a}-\x{52f}\x{531}-\x{556}\x{559}-\x{55f}\x{561}-\x{587}\x{589}\x{903}-\x{939}\x{93b}\x{93d}-\x{940}\x{949}-\x{94c}\x{94e}-\x{950}\x{958}-\x{961}\x{964}-\x{980}\x{982}\x{983}\x{985}-\x{98c}\x{98f}\x{990}\x{993}-\x{9a8}\x{9aa}-\x{9b0}\x{9b2}\x{9b6}-\x{9b9}\x{9bd}-\x{9c0}\x{9c7}\x{9c8}\x{9cb}\x{9cc}\x{9ce}\x{9d7}\x{9dc}\x{9dd}\x{9df}-\x{9e1}\x{9e6}-\x{9f1}\x{9f4}-\x{9fa}\x{a03}\x{a05}-\x{a0a}\x{a0f}\x{a10}\x{a13}-\x{a28}\x{a2a}-\x{a30}\x{a32}\x{a33}\x{a35}\x{a36}\x{a38}\x{a39}\x{a3e}-\x{a40}\x{a59}-\x{a5c}\x{a5e}\x{a66}-\x{a6f}\x{a72}-\x{a74}\x{a83}\x{a85}-\x{a8d}\x{a8f}-\x{a91}\x{a93}-\x{aa8}\x{aaa}-\x{ab0}\x{ab2}\x{ab3}\x{ab5}-\x{ab9}\x{abd}-\x{ac0}\x{ac9}\x{acb}\x{acc}\x{ad0}\x{ae0}\x{ae1}\x{ae6}-\x{af0}\x{af9}\x{b02}\x{b03}\x{b05}-\x{b0c}\x{b0f}\x{b10}\x{b13}-\x{b28}\x{b2a}-\x{b30}\x{b32}\x{b33}\x{b35}-\x{b39}\x{b3d}\x{b3e}\x{b40}\x{b47}\x{b48}\x{b4b}\x{b4c}\x{b57}\x{b5c}\x{b5d}\x{b5f}-\x{b61}\x{b66}-\x{b77}\x{b83}\x{b85}-\x{b8a}\x{b8e}-\x{b90}\x{b92}-\x{b95}\x{b99}\x{b9a}\x{b9c}\x{b9e}\x{b9f}\x{ba3}\x{ba4}\x{ba8}-\x{baa}\x{bae}-\x{bb9}\x{bbe}\x{bbf}\x{bc1}\x{bc2}\x{bc6}-\x{bc8}\x{bca}-\x{bcc}\x{bd0}\x{bd7}\x{be6}-\x{bf2}\x{c01}-\x{c03}\x{c05}-\x{c0c}\x{c0e}-\x{c10}\x{c12}-\x{c28}\x{c2a}-\x{c39}\x{c3d}\x{c41}-\x{c44}\x{c58}-\x{c5a}\x{c60}\x{c61}\x{c66}-\x{c6f}\x{c7f}\x{c82}\x{c83}\x{c85}-\x{c8c}\x{c8e}-\x{c90}\x{c92}-\x{ca8}\x{caa}-\x{cb3}\x{cb5}-\x{cb9}\x{cbd}-\x{cc4}\x{cc6}-\x{cc8}\x{cca}\x{ccb}\x{cd5}\x{cd6}\x{cde}\x{ce0}\x{ce1}\x{ce6}-\x{cef}\x{cf1}\x{cf2}\x{d02}\x{d03}\x{d05}-\x{d0c}\x{d0e}-\x{d10}\x{d12}-\x{d3a}\x{d3d}-\x{d40}\x{d46}-\x{d48}\x{d4a}-\x{d4c}\x{d4e}\x{d57}\x{d5f}-\x{d61}\x{d66}-\x{d75}\x{d79}-\x{d7f}\x{d82}\x{d83}\x{d85}-\x{d96}\x{d9a}-\x{db1}\x{db3}-\x{dbb}\x{dbd}\x{dc0}-\x{dc6}\x{dcf}-\x{dd1}\x{dd8}-\x{ddf}\x{de6}-\x{def}\x{df2}-\x{df4}\x{e01}-\x{e30}\x{e32}\x{e33}\x{e40}-\x{e46}\x{e4f}-\x{e5b}\x{e81}\x{e82}\x{e84}\x{e87}\x{e88}\x{e8a}\x{e8d}\x{e94}-\x{e97}\x{e99}-\x{e9f}\x{ea1}-\x{ea3}\x{ea5}\x{ea7}\x{eaa}\x{eab}\x{ead}-\x{eb0}\x{eb2}\x{eb3}\x{ebd}\x{ec0}-\x{ec4}\x{ec6}\x{ed0}-\x{ed9}\x{edc}-\x{edf}\x{f00}-\x{f17}\x{f1a}-\x{f34}\x{f36}\x{f38}\x{f3e}-\x{f47}\x{f49}-\x{f6c}\x{f7f}\x{f85}\x{f88}-\x{f8c}\x{fbe}-\x{fc5}\x{fc7}-\x{fcc}\x{fce}-\x{fda}\x{1000}-\x{102c}\x{1031}\x{1038}\x{103b}\x{103c}\x{103f}-\x{1057}\x{105a}-\x{105d}\x{1061}-\x{1070}\x{1075}-\x{1081}\x{1083}\x{1084}\x{1087}-\x{108c}\x{108e}-\x{109c}\x{109e}-\x{10c5}\x{10c7}\x{10cd}\x{10d0}-\x{1248}\x{124a}-\x{124d}\x{1250}-\x{1256}\x{1258}\x{125a}-\x{125d}\x{1260}-\x{1288}\x{128a}-\x{128d}\x{1290}-\x{12b0}\x{12b2}-\x{12b5}\x{12b8}-\x{12be}\x{12c0}\x{12c2}-\x{12c5}\x{12c8}-\x{12d6}\x{12d8}-\x{1310}\x{1312}-\x{1315}\x{1318}-\x{135a}\x{1360}-\x{137c}\x{1380}-\x{138f}\x{13a0}-\x{13f5}\x{13f8}-\x{13fd}\x{1401}-\x{167f}\x{1681}-\x{169a}\x{16a0}-\x{16f8}\x{1700}-\x{170c}\x{170e}-\x{1711}\x{1720}-\x{1731}\x{1735}\x{1736}\x{1740}-\x{1751}\x{1760}-\x{176c}\x{176e}-\x{1770}\x{1780}-\x{17b3}\x{17b6}\x{17be}-\x{17c5}\x{17c7}\x{17c8}\x{17d4}-\x{17da}\x{17dc}\x{17e0}-\x{17e9}\x{1810}-\x{1819}\x{1820}-\x{1877}\x{1880}-\x{18a8}\x{18aa}\x{18b0}-\x{18f5}\x{1900}-\x{191e}\x{1923}-\x{1926}\x{1929}-\x{192b}\x{1930}\x{1931}\x{1933}-\x{1938}\x{1946}-\x{196d}\x{1970}-\x{1974}\x{1980}-\x{19ab}\x{19b0}-\x{19c9}\x{19d0}-\x{19da}\x{1a00}-\x{1a16}\x{1a19}\x{1a1a}\x{1a1e}-\x{1a55}\x{1a57}\x{1a61}\x{1a63}\x{1a64}\x{1a6d}-\x{1a72}\x{1a80}-\x{1a89}\x{1a90}-\x{1a99}\x{1aa0}-\x{1aad}\x{1b04}-\x{1b33}\x{1b35}\x{1b3b}\x{1b3d}-\x{1b41}\x{1b43}-\x{1b4b}\x{1b50}-\x{1b6a}\x{1b74}-\x{1b7c}\x{1b82}-\x{1ba1}\x{1ba6}\x{1ba7}\x{1baa}\x{1bae}-\x{1be5}\x{1be7}\x{1bea}-\x{1bec}\x{1bee}\x{1bf2}\x{1bf3}\x{1bfc}-\x{1c2b}\x{1c34}\x{1c35}\x{1c3b}-\x{1c49}\x{1c4d}-\x{1c7f}\x{1cc0}-\x{1cc7}\x{1cd3}\x{1ce1}\x{1ce9}-\x{1cec}\x{1cee}-\x{1cf3}\x{1cf5}\x{1cf6}\x{1d00}-\x{1dbf}\x{1e00}-\x{1f15}\x{1f18}-\x{1f1d}\x{1f20}-\x{1f45}\x{1f48}-\x{1f4d}\x{1f50}-\x{1f57}\x{1f59}\x{1f5b}\x{1f5d}\x{1f5f}-\x{1f7d}\x{1f80}-\x{1fb4}\x{1fb6}-\x{1fbc}\x{1fbe}\x{1fc2}-\x{1fc4}\x{1fc6}-\x{1fcc}\x{1fd0}-\x{1fd3}\x{1fd6}-\x{1fdb}\x{1fe0}-\x{1fec}\x{1ff2}-\x{1ff4}\x{1ff6}-\x{1ffc}\x{200e}\x{2071}\x{207f}\x{2090}-\x{209c}\x{2102}\x{2107}\x{210a}-\x{2113}\x{2115}\x{2119}-\x{211d}\x{2124}\x{2126}\x{2128}\x{212a}-\x{212d}\x{212f}-\x{2139}\x{213c}-\x{213f}\x{2145}-\x{2149}\x{214e}\x{214f}\x{2160}-\x{2188}\x{2336}-\x{237a}\x{2395}\x{249c}-\x{24e9}\x{26ac}\x{2800}-\x{28ff}\x{2c00}-\x{2c2e}\x{2c30}-\x{2c5e}\x{2c60}-\x{2ce4}\x{2ceb}-\x{2cee}\x{2cf2}\x{2cf3}\x{2d00}-\x{2d25}\x{2d27}\x{2d2d}\x{2d30}-\x{2d67}\x{2d6f}\x{2d70}\x{2d80}-\x{2d96}\x{2da0}-\x{2da6}\x{2da8}-\x{2dae}\x{2db0}-\x{2db6}\x{2db8}-\x{2dbe}\x{2dc0}-\x{2dc6}\x{2dc8}-\x{2dce}\x{2dd0}-\x{2dd6}\x{2dd8}-\x{2dde}\x{3005}-\x{3007}\x{3021}-\x{3029}\x{302e}\x{302f}\x{3031}-\x{3035}\x{3038}-\x{303c}\x{3041}-\x{3096}\x{309d}-\x{309f}\x{30a1}-\x{30fa}\x{30fc}-\x{30ff}\x{3105}-\x{312d}\x{3131}-\x{318e}\x{3190}-\x{31ba}\x{31f0}-\x{321c}\x{3220}-\x{324f}\x{3260}-\x{327b}\x{327f}-\x{32b0}\x{32c0}-\x{32cb}\x{32d0}-\x{32fe}\x{3300}-\x{3376}\x{337b}-\x{33dd}\x{33e0}-\x{33fe}\x{3400}-\x{4db5}\x{4e00}-\x{9fd5}\x{a000}-\x{a48c}\x{a4d0}-\x{a60c}\x{a610}-\x{a62b}\x{a640}-\x{a66e}\x{a680}-\x{a69d}\x{a6a0}-\x{a6ef}\x{a6f2}-\x{a6f7}\x{a722}-\x{a787}\x{a789}-\x{a7ad}\x{a7b0}-\x{a7b7}\x{a7f7}-\x{a801}\x{a803}-\x{a805}\x{a807}-\x{a80a}\x{a80c}-\x{a824}\x{a827}\x{a830}-\x{a837}\x{a840}-\x{a873}\x{a880}-\x{a8c3}\x{a8ce}-\x{a8d9}\x{a8f2}-\x{a8fd}\x{a900}-\x{a925}\x{a92e}-\x{a946}\x{a952}\x{a953}\x{a95f}-\x{a97c}\x{a983}-\x{a9b2}\x{a9b4}\x{a9b5}\x{a9ba}\x{a9bb}\x{a9bd}-\x{a9cd}\x{a9cf}-\x{a9d9}\x{a9de}-\x{a9e4}\x{a9e6}-\x{a9fe}\x{aa00}-\x{aa28}\x{aa2f}\x{aa30}\x{aa33}\x{aa34}\x{aa40}-\x{aa42}\x{aa44}-\x{aa4b}\x{aa4d}\x{aa50}-\x{aa59}\x{aa5c}-\x{aa7b}\x{aa7d}-\x{aaaf}\x{aab1}\x{aab5}\x{aab6}\x{aab9}-\x{aabd}\x{aac0}\x{aac2}\x{aadb}-\x{aaeb}\x{aaee}-\x{aaf5}\x{ab01}-\x{ab06}\x{ab09}-\x{ab0e}\x{ab11}-\x{ab16}\x{ab20}-\x{ab26}\x{ab28}-\x{ab2e}\x{ab30}-\x{ab65}\x{ab70}-\x{abe4}\x{abe6}\x{abe7}\x{abe9}-\x{abec}\x{abf0}-\x{abf9}\x{ac00}-\x{d7a3}\x{d7b0}-\x{d7c6}\x{d7cb}-\x{d7fb}\x{e000}-\x{fa6d}\x{fa70}-\x{fad9}\x{fb00}-\x{fb06}\x{fb13}-\x{fb17}\x{ff21}-\x{ff3a}\x{ff41}-\x{ff5a}\x{ff66}-\x{ffbe}\x{ffc2}-\x{ffc7}\x{ffca}-\x{ffcf}\x{ffd2}-\x{ffd7}\x{ffda}-\x{ffdc}\x{10000}-\x{1000b}\x{1000d}-\x{10026}\x{10028}-\x{1003a}\x{1003c}\x{1003d}\x{1003f}-\x{1004d}\x{10050}-\x{1005d}\x{10080}-\x{100fa}\x{10100}\x{10102}\x{10107}-\x{10133}\x{10137}-\x{1013f}\x{101d0}-\x{101fc}\x{10280}-\x{1029c}\x{102a0}-\x{102d0}\x{10300}-\x{10323}\x{10330}-\x{1034a}\x{10350}-\x{10375}\x{10380}-\x{1039d}\x{1039f}-\x{103c3}\x{103c8}-\x{103d5}\x{10400}-\x{1049d}\x{104a0}-\x{104a9}\x{10500}-\x{10527}\x{10530}-\x{10563}\x{1056f}\x{10600}-\x{10736}\x{10740}-\x{10755}\x{10760}-\x{10767}\x{11000}\x{11002}-\x{11037}\x{11047}-\x{1104d}\x{11066}-\x{1106f}\x{11082}-\x{110b2}\x{110b7}\x{110b8}\x{110bb}-\x{110c1}\x{110d0}-\x{110e8}\x{110f0}-\x{110f9}\x{11103}-\x{11126}\x{1112c}\x{11136}-\x{11143}\x{11150}-\x{11172}\x{11174}-\x{11176}\x{11182}-\x{111b5}\x{111bf}-\x{111c9}\x{111cd}\x{111d0}-\x{111df}\x{111e1}-\x{111f4}\x{11200}-\x{11211}\x{11213}-\x{1122e}\x{11232}\x{11233}\x{11235}\x{11238}-\x{1123d}\x{11280}-\x{11286}\x{11288}\x{1128a}-\x{1128d}\x{1128f}-\x{1129d}\x{1129f}-\x{112a9}\x{112b0}-\x{112de}\x{112e0}-\x{112e2}\x{112f0}-\x{112f9}\x{11302}\x{11303}\x{11305}-\x{1130c}\x{1130f}\x{11310}\x{11313}-\x{11328}\x{1132a}-\x{11330}\x{11332}\x{11333}\x{11335}-\x{11339}\x{1133d}-\x{1133f}\x{11341}-\x{11344}\x{11347}\x{11348}\x{1134b}-\x{1134d}\x{11350}\x{11357}\x{1135d}-\x{11363}\x{11480}-\x{114b2}\x{114b9}\x{114bb}-\x{114be}\x{114c1}\x{114c4}-\x{114c7}\x{114d0}-\x{114d9}\x{11580}-\x{115b1}\x{115b8}-\x{115bb}\x{115be}\x{115c1}-\x{115db}\x{11600}-\x{11632}\x{1163b}\x{1163c}\x{1163e}\x{11641}-\x{11644}\x{11650}-\x{11659}\x{11680}-\x{116aa}\x{116ac}\x{116ae}\x{116af}\x{116b6}\x{116c0}-\x{116c9}\x{11700}-\x{11719}\x{11720}\x{11721}\x{11726}\x{11730}-\x{1173f}\x{118a0}-\x{118f2}\x{118ff}\x{11ac0}-\x{11af8}\x{12000}-\x{12399}\x{12400}-\x{1246e}\x{12470}-\x{12474}\x{12480}-\x{12543}\x{13000}-\x{1342e}\x{14400}-\x{14646}\x{16800}-\x{16a38}\x{16a40}-\x{16a5e}\x{16a60}-\x{16a69}\x{16a6e}\x{16a6f}\x{16ad0}-\x{16aed}\x{16af5}\x{16b00}-\x{16b2f}\x{16b37}-\x{16b45}\x{16b50}-\x{16b59}\x{16b5b}-\x{16b61}\x{16b63}-\x{16b77}\x{16b7d}-\x{16b8f}\x{16f00}-\x{16f44}\x{16f50}-\x{16f7e}\x{16f93}-\x{16f9f}\x{1b000}\x{1b001}\x{1bc00}-\x{1bc6a}\x{1bc70}-\x{1bc7c}\x{1bc80}-\x{1bc88}\x{1bc90}-\x{1bc99}\x{1bc9c}\x{1bc9f}\x{1d000}-\x{1d0f5}\x{1d100}-\x{1d126}\x{1d129}-\x{1d166}\x{1d16a}-\x{1d172}\x{1d183}\x{1d184}\x{1d18c}-\x{1d1a9}\x{1d1ae}-\x{1d1e8}\x{1d360}-\x{1d371}\x{1d400}-\x{1d454}\x{1d456}-\x{1d49c}\x{1d49e}\x{1d49f}\x{1d4a2}\x{1d4a5}\x{1d4a6}\x{1d4a9}-\x{1d4ac}\x{1d4ae}-\x{1d4b9}\x{1d4bb}\x{1d4bd}-\x{1d4c3}\x{1d4c5}-\x{1d505}\x{1d507}-\x{1d50a}\x{1d50d}-\x{1d514}\x{1d516}-\x{1d51c}\x{1d51e}-\x{1d539}\x{1d53b}-\x{1d53e}\x{1d540}-\x{1d544}\x{1d546}\x{1d54a}-\x{1d550}\x{1d552}-\x{1d6a5}\x{1d6a8}-\x{1d6da}\x{1d6dc}-\x{1d714}\x{1d716}-\x{1d74e}\x{1d750}-\x{1d788}\x{1d78a}-\x{1d7c2}\x{1d7c4}-\x{1d7cb}\x{1d800}-\x{1d9ff}\x{1da37}-\x{1da3a}\x{1da6d}-\x{1da74}\x{1da76}-\x{1da83}\x{1da85}-\x{1da8b}\x{1f110}-\x{1f12e}\x{1f130}-\x{1f169}\x{1f170}-\x{1f19a}\x{1f1e6}-\x{1f202}\x{1f210}-\x{1f23a}\x{1f240}-\x{1f248}\x{1f250}\x{1f251}\x{20000}-\x{2a6d6}\x{2a700}-\x{2b734}\x{2b740}-\x{2b81d}\x{2b820}-\x{2cea1}\x{2f800}-\x{2fa1d}\x{f0000}-\x{ffffd}\x{100000}-\x{10fffd}])|([\x{590}\x{5be}\x{5c0}\x{5c3}\x{5c6}\x{5c8}-\x{5ff}\x{7c0}-\x{7ea}\x{7f4}\x{7f5}\x{7fa}-\x{815}\x{81a}\x{824}\x{828}\x{82e}-\x{858}\x{85c}-\x{89f}\x{200f}\x{fb1d}\x{fb1f}-\x{fb28}\x{fb2a}-\x{fb4f}\x{10800}-\x{1091e}\x{10920}-\x{10a00}\x{10a04}\x{10a07}-\x{10a0b}\x{10a10}-\x{10a37}\x{10a3b}-\x{10a3e}\x{10a40}-\x{10ae4}\x{10ae7}-\x{10b38}\x{10b40}-\x{10e5f}\x{10e7f}-\x{10fff}\x{1e800}-\x{1e8cf}\x{1e8d7}-\x{1edff}\x{1ef00}-\x{1efff}\x{608}\x{60b}\x{60d}\x{61b}-\x{64a}\x{66d}-\x{66f}\x{671}-\x{6d5}\x{6e5}\x{6e6}\x{6ee}\x{6ef}\x{6fa}-\x{710}\x{712}-\x{72f}\x{74b}-\x{7a5}\x{7b1}-\x{7bf}\x{8a0}-\x{8e2}\x{fb50}-\x{fd3d}\x{fd40}-\x{fdcf}\x{fdf0}-\x{fdfc}\x{fdfe}\x{fdff}\x{fe70}-\x{fefe}\x{1ee00}-\x{1eeef}\x{1eef2}-\x{1eeff}]))/u';
340    // @codeCoverageIgnoreEnd
341
342    /**
343     * @internal Use LanguageFactory instead.
344     */
345    public function __construct(
346        string $code,
347        NamespaceInfo $namespaceInfo,
348        LocalisationCache $localisationCache,
349        LanguageNameUtils $langNameUtils,
350        LanguageFallback $langFallback,
351        LanguageConverterFactory $converterFactory,
352        HookContainer $hookContainer,
353        Config $config
354    ) {
355        $this->mCode = $code;
356        $this->namespaceInfo = $namespaceInfo;
357        $this->localisationCache = $localisationCache;
358        $this->langNameUtils = $langNameUtils;
359        $this->langFallback = $langFallback;
360        $this->converterFactory = $converterFactory;
361        $this->hookContainer = $hookContainer;
362        $this->hookRunner = new HookRunner( $hookContainer );
363        $this->config = $config;
364    }
365
366    /**
367     * @return array
368     * @since 1.19
369     */
370    public function getFallbackLanguages() {
371        return $this->langFallback->getAll( $this->mCode );
372    }
373
374    /**
375     * Exports $wgBookstoreListEn
376     * @return array
377     */
378    public function getBookstoreList() {
379        return $this->localisationCache->getItem( $this->mCode, 'bookstoreList' );
380    }
381
382    /**
383     * Returns an array of localised namespaces (with underscores, without considering language
384     * variants) indexed by their numbers. If the namespace is not available in localised form, it
385     * will be included in English.
386     *
387     * @return array<int,string> List of localized namespace names, indexed by numeric namespace ID.
388     */
389    public function getNamespaces() {
390        if ( $this->namespaceNames === null ) {
391            $metaNamespace = $this->config->get( MainConfigNames::MetaNamespace );
392            $metaNamespaceTalk = $this->config->get( MainConfigNames::MetaNamespaceTalk );
393            $extraNamespaces = $this->config->get( MainConfigNames::ExtraNamespaces );
394            $validNamespaces = $this->namespaceInfo->getCanonicalNamespaces();
395
396            // @phan-suppress-next-line PhanTypeMismatchProperty
397            $this->namespaceNames = $extraNamespaces +
398                $this->localisationCache->getItem( $this->mCode, 'namespaceNames' );
399            // @phan-suppress-next-line PhanTypeInvalidLeftOperand
400            $this->namespaceNames += $validNamespaces;
401
402            $this->namespaceNames[NS_PROJECT] = $metaNamespace;
403            if ( $metaNamespaceTalk ) {
404                $this->namespaceNames[NS_PROJECT_TALK] = $metaNamespaceTalk;
405            } else {
406                $talk = $this->namespaceNames[NS_PROJECT_TALK];
407                $this->namespaceNames[NS_PROJECT_TALK] =
408                    $this->fixVariableInNamespace( $talk );
409            }
410
411            # Sometimes a language will be localised but not actually exist on this wiki.
412            foreach ( $this->namespaceNames as $key => $text ) {
413                if ( !isset( $validNamespaces[$key] ) ) {
414                    unset( $this->namespaceNames[$key] );
415                }
416            }
417
418            # The above mixing may leave namespaces out of canonical order.
419            # Re-order by namespace ID number...
420            ksort( $this->namespaceNames );
421
422            $this->getHookRunner()->onLanguageGetNamespaces( $this->namespaceNames );
423        }
424
425        return $this->namespaceNames;
426    }
427
428    /**
429     * Arbitrarily set all the namespace names at once. Mainly used for testing
430     * @param string[] $namespaces Array of namespaces (id => name)
431     */
432    public function setNamespaces( array $namespaces ) {
433        $this->namespaceNames = $namespaces;
434        $this->mNamespaceIds = null;
435    }
436
437    /**
438     * Resets all the namespace caches. Mainly used for testing
439     * @deprecated since 1.39 Use MediaWikiServices::resetServiceForTesting() instead.
440     */
441    public function resetNamespaces() {
442        $this->namespaceNames = null;
443        $this->mNamespaceIds = null;
444        $this->namespaceAliases = null;
445    }
446
447    /**
448     * A convenience function that returns {@see getNamespaces} with spaces instead of underscores
449     * in values.
450     *
451     * NOTE: This is not suitable for UI text, as language variants of namespace names defined via
452     * system messages are ignored. Use {@see LanguageConverter::convertNamespace} instead.
453     *
454     * @return array<int,string>
455     */
456    public function getFormattedNamespaces() {
457        $ns = $this->getNamespaces();
458        foreach ( $ns as $k => $v ) {
459            $ns[$k] = strtr( $v, '_', ' ' );
460        }
461        return $ns;
462    }
463
464    /**
465     * Get a namespace value by key
466     *
467     * Namespace name uses underscores (not spaces), e.g. 'MediaWiki_talk'.
468     *
469     * <code>
470     * $mw_ns = $lang->getNsText( NS_MEDIAWIKI_TALK );
471     * echo $mw_ns; // prints 'MediaWiki_talk'
472     * </code>
473     *
474     * @param int $index The array key of the namespace to return
475     * @return string|false String if the namespace value exists, otherwise false
476     */
477    public function getNsText( $index ) {
478        $ns = $this->getNamespaces();
479        return $ns[$index] ?? false;
480    }
481
482    /**
483     * A convenience function that returns the same thing as
484     * getNsText() except with '_' changed to ' ', useful for
485     * producing output.
486     *
487     * <code>
488     * $mw_ns = $lang->getFormattedNsText( NS_MEDIAWIKI_TALK );
489     * echo $mw_ns; // prints 'MediaWiki talk'
490     * </code>
491     *
492     * @param int $index The array key of the namespace to return
493     * @return string Namespace name without underscores (empty string if namespace does not exist)
494     */
495    public function getFormattedNsText( $index ) {
496        $ns = $this->getNsText( $index );
497        return $ns === false ? '' : strtr( $ns, '_', ' ' );
498    }
499
500    /**
501     * Returns gender-dependent namespace alias if available.
502     * See https://www.mediawiki.org/wiki/Manual:$wgExtraGenderNamespaces
503     * @param int $index Namespace index
504     * @param string $gender Gender key (male, female... )
505     * @return string|false
506     * @since 1.18
507     */
508    public function getGenderNsText( $index, $gender ) {
509        $extraGenderNamespaces = $this->config->get( MainConfigNames::ExtraGenderNamespaces );
510
511        $ns = $extraGenderNamespaces +
512            (array)$this->localisationCache->getItem( $this->mCode, 'namespaceGenderAliases' );
513
514        return $ns[$index][$gender] ?? $this->getNsText( $index );
515    }
516
517    /**
518     * Whether this language uses gender-dependent namespace aliases.
519     * See https://www.mediawiki.org/wiki/Manual:$wgExtraGenderNamespaces
520     * @return bool
521     * @since 1.18
522     */
523    public function needsGenderDistinction() {
524        $extraGenderNamespaces = $this->config->get( MainConfigNames::ExtraGenderNamespaces );
525        $extraNamespaces = $this->config->get( MainConfigNames::ExtraNamespaces );
526        if ( count( $extraGenderNamespaces ) > 0 ) {
527            // $wgExtraGenderNamespaces overrides everything
528            return true;
529        } elseif ( isset( $extraNamespaces[NS_USER] ) && isset( $extraNamespaces[NS_USER_TALK] ) ) {
530            // @todo There may be other gender namespace than NS_USER & NS_USER_TALK in the future
531            // $wgExtraNamespaces overrides any gender aliases specified in i18n files
532            return false;
533        } else {
534            // Check what is in i18n files
535            $aliases = (array)$this->localisationCache->getItem( $this->mCode, 'namespaceGenderAliases' );
536            return count( $aliases ) > 0;
537        }
538    }
539
540    /**
541     * Get a namespace key by case-insensitive value.
542     * Only matches namespace names for the current language, not the
543     * canonical ones defined in Namespace.php.
544     *
545     * @param string $text
546     * @return int|false An integer if $text is a valid value otherwise false
547     */
548    public function getLocalNsIndex( $text ) {
549        $lctext = $this->lc( $text );
550        $ids = $this->getNamespaceIds();
551        return $ids[$lctext] ?? false;
552    }
553
554    /**
555     * @return array<string,int> Map from names to namespace IDs. Note that each
556     * namespace ID can have multiple alias.
557     */
558    public function getNamespaceAliases() {
559        if ( $this->namespaceAliases === null ) {
560            $aliases = $this->localisationCache->getItem( $this->mCode, 'namespaceAliases' );
561            if ( !$aliases ) {
562                $aliases = [];
563            } else {
564                foreach ( $aliases as $name => $index ) {
565                    if ( $index === NS_PROJECT_TALK ) {
566                        unset( $aliases[$name] );
567                        $name = $this->fixVariableInNamespace( $name );
568                        $aliases[$name] = $index;
569                    }
570                }
571            }
572
573            $extraGenderNamespaces = $this->config->get( MainConfigNames::ExtraGenderNamespaces );
574            $genders = $extraGenderNamespaces + (array)$this->localisationCache
575                ->getItem( $this->mCode, 'namespaceGenderAliases' );
576            foreach ( $genders as $index => $forms ) {
577                foreach ( $forms as $alias ) {
578                    $aliases[$alias] = $index;
579                }
580            }
581
582            $langConverter = $this->getConverterInternal();
583            # Also add converted namespace names as aliases, to avoid confusion.
584            $convertedNames = [];
585            foreach ( $langConverter->getVariants() as $variant ) {
586                if ( $variant === $this->mCode ) {
587                    continue;
588                }
589                foreach ( $this->getNamespaces() as $ns => $_ ) {
590                    $convertedNames[$langConverter->convertNamespace( $ns, $variant )] = $ns;
591                }
592            }
593
594            $this->namespaceAliases = $aliases + $convertedNames;
595
596            // In the case of conflicts between $wgNamespaceAliases and other sources
597            // of aliasing, $wgNamespaceAliases wins.
598            $this->namespaceAliases = $this->config->get( MainConfigNames::NamespaceAliases ) +
599                $this->namespaceAliases;
600
601            # Filter out aliases to namespaces that don't exist, e.g. from extensions
602            # that aren't loaded here but are included in the l10n cache.
603            # (array_intersect preserves keys from its first argument)
604            $this->namespaceAliases = array_intersect(
605                $this->namespaceAliases,
606                array_keys( $this->getNamespaces() )
607            );
608        }
609
610        return $this->namespaceAliases;
611    }
612
613    /**
614     * @return array<string,int> indexed by localized lower-cased namespace name
615     */
616    public function getNamespaceIds() {
617        if ( $this->mNamespaceIds === null ) {
618            # Put namespace names and aliases into a hashtable.
619            # If this is too slow, then we should arrange it so that it is done
620            # before caching. The catch is that at pre-cache time, the above
621            # class-specific fixup hasn't been done.
622            $this->mNamespaceIds = [];
623            foreach ( $this->getNamespaces() as $index => $name ) {
624                $this->mNamespaceIds[$this->lc( $name )] = $index;
625            }
626            foreach ( $this->getNamespaceAliases() as $name => $index ) {
627                $this->mNamespaceIds[$this->lc( $name )] = $index;
628            }
629        }
630        return $this->mNamespaceIds;
631    }
632
633    /**
634     * Get a namespace key by case-insensitive value. Canonical namespace
635     * names override custom ones defined for the current language.
636     *
637     * @param string $text
638     * @return int|false An integer if $text is a valid value otherwise false
639     */
640    public function getNsIndex( $text ) {
641        $lctext = $this->lc( $text );
642        $ns = $this->namespaceInfo->getCanonicalIndex( $lctext );
643        if ( $ns !== null ) {
644            return $ns;
645        }
646        $ids = $this->getNamespaceIds();
647        return $ids[$lctext] ?? false;
648    }
649
650    /**
651     * Short names for language variants used for language conversion links.
652     *
653     * @param string $code
654     * @param bool $usemsg Use the "variantname-xyz" message if it exists
655     * @return string
656     */
657    public function getVariantname( $code, $usemsg = true ) {
658        if ( $usemsg ) {
659            $msg = $this->msg( "variantname-$code" );
660            if ( $msg->exists() ) {
661                return $msg->text();
662            }
663        }
664        $name = $this->langNameUtils->getLanguageName( $code );
665        if ( $name ) {
666            return $name; # if it's defined as a language name, show that
667        } else {
668            # otherwise, output the language code
669            return $code;
670        }
671    }
672
673    /**
674     * @return string[]|false List of date format preference keys, or false if disabled.
675     */
676    public function getDatePreferences() {
677        return $this->localisationCache->getItem( $this->mCode, 'datePreferences' );
678    }
679
680    /**
681     * @return string[]
682     */
683    public function getDateFormats() {
684        return $this->localisationCache->getItem( $this->mCode, 'dateFormats' );
685    }
686
687    /**
688     * @return string
689     */
690    public function getDefaultDateFormat() {
691        $df = $this->localisationCache->getItem( $this->mCode, 'defaultDateFormat' );
692        if ( $df === 'dmy or mdy' ) {
693            return $this->config->get( MainConfigNames::AmericanDates ) ? 'mdy' : 'dmy';
694        } else {
695            return $df;
696        }
697    }
698
699    /**
700     * @return string[]
701     */
702    public function getDatePreferenceMigrationMap() {
703        return $this->localisationCache->getItem( $this->mCode, 'datePreferenceMigrationMap' );
704    }
705
706    /**
707     * Get a message from the MediaWiki namespace.
708     *
709     * @param string $msg Message name
710     * @return string
711     */
712    public function getMessageFromDB( $msg ) {
713        return $this->msg( $msg )->text();
714    }
715
716    /**
717     * Gets the Message object from this language. Only for use inside this class.
718     *
719     * @param string $msg Message name
720     * @phpcs:ignore Generic.Files.LineLength
721     * @param MessageParam|MessageSpecifier|string|int|float|list<MessageParam|MessageSpecifier|string|int|float> ...$params
722     *   See Message::params()
723     * @return Message
724     */
725    protected function msg( $msg, ...$params ) {
726        return wfMessage( $msg, ...$params )->inLanguage( $this );
727    }
728
729    /**
730     * @param int $key Number from 1 to 12
731     * @return string
732     */
733    public function getMonthName( $key ) {
734        return $this->getMessageFromDB( self::MONTH_MESSAGES[$key - 1] );
735    }
736
737    /**
738     * @return string[] Indexed from 0 to 11
739     */
740    public function getMonthNamesArray() {
741        $monthNames = [ '' ];
742        for ( $i = 1; $i <= 12; $i++ ) {
743            $monthNames[] = $this->getMonthName( $i );
744        }
745        return $monthNames;
746    }
747
748    /**
749     * @param int $key Number from 1 to 12
750     * @return string
751     */
752    public function getMonthNameGen( $key ) {
753        return $this->getMessageFromDB( self::MONTH_GENITIVE_MESSAGES[$key - 1] );
754    }
755
756    /**
757     * @param int $key Number from 1 to 12
758     * @return string
759     */
760    public function getMonthAbbreviation( $key ) {
761        return $this->getMessageFromDB( self::MONTH_ABBREVIATED_MESSAGES[$key - 1] );
762    }
763
764    /**
765     * @return string[] Indexed from 0 to 11
766     */
767    public function getMonthAbbreviationsArray() {
768        $monthNames = [ '' ];
769        for ( $i = 1; $i <= 12; $i++ ) {
770            $monthNames[] = $this->getMonthAbbreviation( $i );
771        }
772        return $monthNames;
773    }
774
775    /**
776     * @param int $key Number from 1 to 7
777     * @return string
778     */
779    public function getWeekdayName( $key ) {
780        return $this->getMessageFromDB( self::WEEKDAY_MESSAGES[$key - 1] );
781    }
782
783    /**
784     * @param int $key Number from 1 to 7
785     * @return string
786     */
787    public function getWeekdayAbbreviation( $key ) {
788        return $this->getMessageFromDB( self::WEEKDAY_ABBREVIATED_MESSAGES[$key - 1] );
789    }
790
791    /**
792     * Create a DateTime object, if it doesn't already exist.
793     *
794     * @param DateTime|false|null &$dateTimeObj
795     * @param string $ts
796     * @param DateTimeZone|false|null $zone
797     * @return DateTime
798     */
799    private static function dateTimeObj( &$dateTimeObj, $ts, $zone ): DateTime {
800        if ( !$dateTimeObj ) {
801            $dateTimeObj = DateTime::createFromFormat(
802                'YmdHis', $ts, $zone ?: new DateTimeZone( 'UTC' )
803            );
804        }
805        return $dateTimeObj;
806    }
807
808    /**
809     * Pass through the result from $dateTimeObj->format()
810     *
811     * @param DateTime|false|null &$dateTimeObj
812     * @param string $ts
813     * @param DateTimeZone|false|null $zone
814     * @param string $code
815     * @return string
816     */
817    private static function dateTimeObjFormat( &$dateTimeObj, $ts, $zone, $code ) {
818        return self::dateTimeObj( $dateTimeObj, $ts, $zone )->format( $code );
819    }
820
821    /**
822     * This is a workalike of PHP's date() function, but with better
823     * internationalisation, a reduced set of format characters, and a better
824     * escaping format.
825     *
826     * Supported format characters are dDjlNwzWFmMntLoYyaAgGhHiscrUeIOPTZ. See
827     * the PHP manual for definitions. There are a number of extensions, which
828     * start with "x":
829     *
830     *    xn   Do not translate digits of the next numeric format character
831     *    xN   Toggle raw digit (xn) flag, stays set until explicitly unset
832     *    xr   Use roman numerals for the next numeric format character
833     *    xh   Use hebrew numerals for the next numeric format character
834     *    xx   Literal x
835     *    xg   Genitive month name
836     *
837     *    xij  j (day number) in Iranian calendar
838     *    xiF  F (month name) in Iranian calendar
839     *    xin  n (month number) in Iranian calendar
840     *    xiy  y (two digit year) in Iranian calendar
841     *    xiY  Y (full year) in Iranian calendar
842     *    xit  t (days in month) in Iranian calendar
843     *    xiz  z (day of the year) in Iranian calendar
844     *
845     *    xjj  j (day number) in Hebrew calendar
846     *    xjF  F (month name) in Hebrew calendar
847     *    xjt  t (days in month) in Hebrew calendar
848     *    xjx  xg (genitive month name) in Hebrew calendar
849     *    xjn  n (month number) in Hebrew calendar
850     *    xjY  Y (full year) in Hebrew calendar
851     *
852     *    xmj  j (day number) in Hijri calendar
853     *    xmF  F (month name) in Hijri calendar
854     *    xmn  n (month number) in Hijri calendar
855     *    xmY  Y (full year) in Hijri calendar
856     *
857     *    xkY  Y (full year) in Thai solar calendar. Months and days are
858     *                       identical to the Gregorian calendar
859     *    xoY  Y (full year) in Minguo calendar or Juche year.
860     *                       Months and days are identical to the
861     *                       Gregorian calendar
862     *    xtY  Y (full year) in Japanese nengo. Months and days are
863     *                       identical to the Gregorian calendar
864     *
865     * Characters enclosed in double quotes will be considered literal (with
866     * the quotes themselves removed). Unmatched quotes will be considered
867     * literal quotes. Example:
868     *
869     * "The month is" F       => The month is January
870     * i's"                   => 20'11"
871     *
872     * Backslash escaping is also supported.
873     *
874     * Input timestamp is assumed to be pre-normalized to the desired local
875     * time zone, if any. Note that the format characters crUeIOPTZ will assume
876     * $ts is UTC if $zone is not given.
877     *
878     * @param string $format
879     * @param string $ts 14-character timestamp
880     *      YYYYMMDDHHMMSS
881     *      01234567890123
882     * @param DateTimeZone|null $zone Timezone of $ts
883     * @param int|null &$ttl The amount of time (in seconds) the output may be cached for.
884     *   Only makes sense if $ts is the current time.
885     * @todo handling of "o" format character for Iranian, Hebrew, Hijri & Thai?
886     *
887     * @return string
888     * @return-taint tainted
889     */
890    public function sprintfDate( $format, $ts, ?DateTimeZone $zone = null, &$ttl = 'unused' ) {
891        // @phan-suppress-previous-line PhanTypeMismatchDefault Type mismatch on pass-by-ref args
892        $s = '';
893        $raw = false;
894        $roman = false;
895        $hebrewNum = false;
896        $dateTimeObj = false;
897        $rawToggle = false;
898        $iranian = false;
899        $hebrew = false;
900        $hijri = false;
901        $thai = false;
902        $minguo = false;
903        $tenno = false;
904
905        $usedSecond = false;
906        $usedMinute = false;
907        $usedHour = false;
908        $usedAMPM = false;
909        $usedDay = false;
910        $usedWeek = false;
911        $usedMonth = false;
912        $usedYear = false;
913        $usedISOYear = false;
914        $usedIsLeapYear = false;
915
916        $usedHebrewMonth = false;
917        $usedIranianMonth = false;
918        $usedHijriMonth = false;
919        $usedHebrewYear = false;
920        $usedIranianYear = false;
921        $usedHijriYear = false;
922        $usedTennoYear = false;
923
924        if ( strlen( $ts ) !== 14 ) {
925            throw new InvalidArgumentException( __METHOD__ . ": The timestamp $ts should have 14 characters" );
926        }
927
928        if ( !ctype_digit( $ts ) ) {
929            throw new InvalidArgumentException( __METHOD__ . ": The timestamp $ts should be a number" );
930        }
931
932        $formatLength = strlen( $format );
933        for ( $p = 0; $p < $formatLength; $p++ ) {
934            $num = false;
935            $code = $format[$p];
936            if ( $code == 'x' && $p < $formatLength - 1 ) {
937                $code .= $format[++$p];
938            }
939
940            if ( ( $code === 'xi'
941                    || $code === 'xj'
942                    || $code === 'xk'
943                    || $code === 'xm'
944                    || $code === 'xo'
945                    || $code === 'xt' )
946                && $p < $formatLength - 1
947            ) {
948                $code .= $format[++$p];
949            }
950
951            switch ( $code ) {
952                case 'xx':
953                    $s .= 'x';
954                    break;
955
956                case 'xn':
957                    $raw = true;
958                    break;
959
960                case 'xN':
961                    $rawToggle = !$rawToggle;
962                    break;
963
964                case 'xr':
965                    $roman = true;
966                    break;
967
968                case 'xh':
969                    $hebrewNum = true;
970                    break;
971
972                case 'xg':
973                    $usedMonth = true;
974                    $s .= $this->getMonthNameGen( (int)substr( $ts, 4, 2 ) );
975                    break;
976
977                case 'xjx':
978                    $usedHebrewMonth = true;
979                    if ( !$hebrew ) {
980                        $hebrew = self::tsToHebrew( $ts );
981                    }
982                    $s .= $this->getMessageFromDB( self::HEBREW_CALENDAR_MONTH_GENITIVE_MESSAGES[$hebrew[1] - 1] );
983                    break;
984
985                case 'd':
986                    $usedDay = true;
987                    $num = substr( $ts, 6, 2 );
988                    break;
989
990                case 'D':
991                    $usedDay = true;
992                    $s .= $this->getWeekdayAbbreviation(
993                        (int)self::dateTimeObjFormat( $dateTimeObj, $ts, $zone, 'w' ) + 1
994                    );
995                    break;
996
997                case 'j':
998                    $usedDay = true;
999                    $num = intval( substr( $ts, 6, 2 ) );
1000                    break;
1001
1002                case 'xij':
1003                    $usedDay = true;
1004                    if ( !$iranian ) {
1005                        $iranian = self::tsToIranian( $ts );
1006                    }
1007                    $num = $iranian[2];
1008                    break;
1009
1010                case 'xmj':
1011                    $usedDay = true;
1012                    if ( !$hijri ) {
1013                        $hijri = self::tsToHijri( $ts );
1014                    }
1015                    $num = $hijri[2];
1016                    break;
1017
1018                case 'xjj':
1019                    $usedDay = true;
1020                    if ( !$hebrew ) {
1021                        $hebrew = self::tsToHebrew( $ts );
1022                    }
1023                    $num = $hebrew[2];
1024                    break;
1025
1026                case 'l':
1027                    $usedDay = true;
1028                    $s .= $this->getWeekdayName(
1029                        (int)self::dateTimeObjFormat( $dateTimeObj, $ts, $zone, 'w' ) + 1
1030                    );
1031                    break;
1032
1033                case 'F':
1034                    $usedMonth = true;
1035                    $s .= $this->getMonthName( (int)substr( $ts, 4, 2 ) );
1036                    break;
1037
1038                case 'xiF':
1039                    $usedIranianMonth = true;
1040                    if ( !$iranian ) {
1041                        $iranian = self::tsToIranian( $ts );
1042                    }
1043                    $s .= $this->getMessageFromDB( self::IRANIAN_CALENDAR_MONTHS_MESSAGES[$iranian[1] - 1] );
1044                    break;
1045
1046                case 'xmF':
1047                    $usedHijriMonth = true;
1048                    if ( !$hijri ) {
1049                        $hijri = self::tsToHijri( $ts );
1050                    }
1051                    $s .= $this->getMessageFromDB( self::HIJRI_CALENDAR_MONTH_MESSAGES[$hijri[1] - 1] );
1052                    break;
1053
1054                case 'xjF':
1055                    $usedHebrewMonth = true;
1056                    if ( !$hebrew ) {
1057                        $hebrew = self::tsToHebrew( $ts );
1058                    }
1059                    $s .= $this->getMessageFromDB( self::HEBREW_CALENDAR_MONTHS_MESSAGES[$hebrew[1] - 1] );
1060                    break;
1061
1062                case 'm':
1063                    $usedMonth = true;
1064                    $num = substr( $ts, 4, 2 );
1065                    break;
1066
1067                case 'M':
1068                    $usedMonth = true;
1069                    $s .= $this->getMonthAbbreviation( (int)substr( $ts, 4, 2 ) );
1070                    break;
1071
1072                case 'n':
1073                    $usedMonth = true;
1074                    $num = intval( substr( $ts, 4, 2 ) );
1075                    break;
1076
1077                case 'xin':
1078                    $usedIranianMonth = true;
1079                    if ( !$iranian ) {
1080                        $iranian = self::tsToIranian( $ts );
1081                    }
1082                    $num = $iranian[1];
1083                    break;
1084
1085                case 'xmn':
1086                    $usedHijriMonth = true;
1087                    if ( !$hijri ) {
1088                        $hijri = self::tsToHijri( $ts );
1089                    }
1090                    $num = $hijri[1];
1091                    break;
1092
1093                case 'xjn':
1094                    $usedHebrewMonth = true;
1095                    if ( !$hebrew ) {
1096                        $hebrew = self::tsToHebrew( $ts );
1097                    }
1098                    $num = $hebrew[1];
1099                    break;
1100
1101                case 'xjt':
1102                    $usedHebrewMonth = true;
1103                    if ( !$hebrew ) {
1104                        $hebrew = self::tsToHebrew( $ts );
1105                    }
1106                    $num = $hebrew[3];
1107                    break;
1108
1109                case 'Y':
1110                    $usedYear = true;
1111                    $num = substr( $ts, 0, 4 );
1112                    break;
1113
1114                case 'xiY':
1115                    $usedIranianYear = true;
1116                    if ( !$iranian ) {
1117                        $iranian = self::tsToIranian( $ts );
1118                    }
1119                    $num = $iranian[0];
1120                    break;
1121
1122                case 'xmY':
1123                    $usedHijriYear = true;
1124                    if ( !$hijri ) {
1125                        $hijri = self::tsToHijri( $ts );
1126                    }
1127                    $num = $hijri[0];
1128                    break;
1129