Fix various typos
[mediawiki.git] / languages / Language.php
blob1f0b17f5077e616261ae1a8b27a46d9ffea2d238
1 <?php
2 /**
3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 * http://www.gnu.org/copyleft/gpl.html
18 * @file
21 /**
22 * @defgroup Language Language
25 use CLDRPluralRuleParser\Evaluator;
26 use MediaWiki\HookContainer\HookContainer;
27 use MediaWiki\HookContainer\HookRunner;
28 use MediaWiki\Languages\LanguageConverterFactory;
29 use MediaWiki\Languages\LanguageFallback;
30 use MediaWiki\Languages\LanguageNameUtils;
31 use MediaWiki\Linker\LinkTarget;
32 use MediaWiki\Logger\LoggerFactory;
33 use MediaWiki\MediaWikiServices;
34 use Wikimedia\Assert\Assert;
36 /**
37 * Internationalisation code
38 * See https://www.mediawiki.org/wiki/Special:MyLanguage/Localisation for more information.
40 * @ingroup Language
42 class Language {
43 /**
44 * Return autonyms in fetchLanguageName(s).
45 * @since 1.32
46 * @deprecated since 1.34, LanguageNameUtils::AUTONYMS
48 public const AS_AUTONYMS = LanguageNameUtils::AUTONYMS;
50 /**
51 * Return all known languages in fetchLanguageName(s).
52 * @since 1.32
53 * @deprecated since 1.34, use LanguageNameUtils::ALL
55 public const ALL = LanguageNameUtils::ALL;
57 /**
58 * Return in fetchLanguageName(s) only the languages for which we have at
59 * least some localisation.
60 * @since 1.32
61 * @deprecated since 1.34, use LanguageNameUtils::SUPPORTED
63 public const SUPPORTED = LanguageNameUtils::SUPPORTED;
65 /**
66 * Use PHP's magic __get handler to handle lazy accessing to
67 * deprecated mConverter.
69 * @param string $name Field name
70 * @return mixed
72 public function __get( string $name ) {
73 if ( $name == "mConverter" ) {
74 wfDeprecatedMsg(
75 'Access to Language::$mConverter was deprecated in MediaWiki 1.35',
76 '1.35' );
77 return $this->getConverter();
79 throw new RuntimeException( "Cannot get '$name' property." );
82 public $mCode;
84 /**
85 * @deprecated since 1.35, use LocalisationCache with custom language config
87 public $mMagicExtensions = [];
89 private $mHtmlCode = null;
91 /**
92 * memoize
93 * @deprecated since 1.35, must be private
95 public $dateFormatStrings = [];
97 /**
98 * memoize
99 * @var array[]
100 * @deprecated since 1.35, must be protected
102 public $mExtendedSpecialPageAliases;
104 /** @var array|null */
105 protected $namespaceNames;
106 protected $mNamespaceIds, $namespaceAliases;
109 * ReplacementArray object memoize
110 * @deprecated since 1.35, must be private
112 public $transformData = [];
114 /** @var LocalisationCache */
115 private $localisationCache;
117 /** @var LanguageNameUtils */
118 private $langNameUtils;
120 /** @var LanguageFallback */
121 private $langFallback;
123 /** @var array[]|null */
124 private $grammarTransformCache;
127 * @var LanguageConverterFactory
129 private $converterFactory;
132 * @var HookContainer
134 private $hookContainer;
137 * @var HookRunner
139 private $hookRunner;
142 * @deprecated since 1.35, use LanguageFactory
143 * @var array
145 public static $mLangObjCache = [];
148 * Return a fallback chain for messages in getFallbacksFor
149 * @since 1.32
150 * @deprecated since 1.35, use LanguageFallback::MESSAGES
152 public const MESSAGES_FALLBACKS = LanguageFallback::MESSAGES;
155 * Return a strict fallback chain in getFallbacksFor
156 * @since 1.32
157 * @deprecated since 1.35, use LanguageFallback::STRICT
159 public const STRICT_FALLBACKS = LanguageFallback::STRICT;
162 * @since 1.35
164 public const WEEKDAY_MESSAGES = [
165 'sunday', 'monday', 'tuesday', 'wednesday', 'thursday',
166 'friday', 'saturday'
170 * @deprecated since 1.35, use the WEEKDAY_MESSAGES constant
172 public static $mWeekdayMsgs = self::WEEKDAY_MESSAGES;
175 * @since 1.35
177 public const WEEKDAY_ABBREVIATED_MESSAGES = [
178 'sun', 'mon', 'tue', 'wed', 'thu', 'fri', 'sat'
182 * @deprecated since 1.35, use the WEEKDAY_ABBREVIATED_MESSAGES constant
184 public static $mWeekdayAbbrevMsgs = self::WEEKDAY_ABBREVIATED_MESSAGES;
187 * @since 1.35
189 public const MONTH_MESSAGES = [
190 'january', 'february', 'march', 'april', 'may_long', 'june',
191 'july', 'august', 'september', 'october', 'november',
192 'december'
196 * @deprecated since 1.35, use the MONTH_MESSAGES constant
198 public static $mMonthMsgs = self::MONTH_MESSAGES;
201 * @since 1.35
203 public const MONTH_GENITIVE_MESSAGES = [
204 'january-gen', 'february-gen', 'march-gen', 'april-gen', 'may-gen', 'june-gen',
205 'july-gen', 'august-gen', 'september-gen', 'october-gen', 'november-gen',
206 'december-gen'
210 * @deprecated since 1.35, use the MONTH_GENITIVE_MESSAGES constant
212 public static $mMonthGenMsgs = self::MONTH_GENITIVE_MESSAGES;
215 * @since 1.35
217 public const MONTH_ABBREVIATED_MESSAGES = [
218 'jan', 'feb', 'mar', 'apr', 'may', 'jun', 'jul', 'aug',
219 'sep', 'oct', 'nov', 'dec'
223 * @deprecated since 1.35, use the MONTH_ABBREVIATED_MESSAGES constant
225 public static $mMonthAbbrevMsgs = self::MONTH_ABBREVIATED_MESSAGES;
228 * @since 1.35
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'
238 * @deprecated since 1.35, use the IRANIAN_CALENDAR_MONTHS_MESSAGES constant
240 public static $mIranianCalendarMonthMsgs = self::IRANIAN_CALENDAR_MONTHS_MESSAGES;
243 * @since 1.35
245 public const HEBREW_CALENDAR_MONTHS_MESSAGES = [
246 'hebrew-calendar-m1', 'hebrew-calendar-m2', 'hebrew-calendar-m3',
247 'hebrew-calendar-m4', 'hebrew-calendar-m5', 'hebrew-calendar-m6',
248 'hebrew-calendar-m7', 'hebrew-calendar-m8', 'hebrew-calendar-m9',
249 'hebrew-calendar-m10', 'hebrew-calendar-m11', 'hebrew-calendar-m12',
250 'hebrew-calendar-m6a', 'hebrew-calendar-m6b'
254 * @deprecated since 1.35, use the HEBREW_CALENDAR_MONTHS_MESSAGES constant
256 public static $mHebrewCalendarMonthMsgs = self::HEBREW_CALENDAR_MONTHS_MESSAGES;
259 * @since 1.35
261 public const HEBREW_CALENDAR_MONTH_GENITIVE_MESSAGES = [
262 'hebrew-calendar-m1-gen', 'hebrew-calendar-m2-gen', 'hebrew-calendar-m3-gen',
263 'hebrew-calendar-m4-gen', 'hebrew-calendar-m5-gen', 'hebrew-calendar-m6-gen',
264 'hebrew-calendar-m7-gen', 'hebrew-calendar-m8-gen', 'hebrew-calendar-m9-gen',
265 'hebrew-calendar-m10-gen', 'hebrew-calendar-m11-gen', 'hebrew-calendar-m12-gen',
266 'hebrew-calendar-m6a-gen', 'hebrew-calendar-m6b-gen'
270 * @deprecated since 1.35, use the HEBREW_CALENDAR_MONTH_GENITIVE_MESSAGES constant
272 public static $mHebrewCalendarMonthGenMsgs = self::HEBREW_CALENDAR_MONTH_GENITIVE_MESSAGES;
275 * @since 1.35
277 public const HIJRI_CALENDAR_MONTH_MESSAGES = [
278 'hijri-calendar-m1', 'hijri-calendar-m2', 'hijri-calendar-m3',
279 'hijri-calendar-m4', 'hijri-calendar-m5', 'hijri-calendar-m6',
280 'hijri-calendar-m7', 'hijri-calendar-m8', 'hijri-calendar-m9',
281 'hijri-calendar-m10', 'hijri-calendar-m11', 'hijri-calendar-m12'
285 * @deprecated since 1.35, use the HIJRI_CALENDAR_MONTH_MESSAGES constant
287 public static $mHijriCalendarMonthMsgs = self::HIJRI_CALENDAR_MONTH_MESSAGES;
290 * @since 1.35
292 protected const DURATION_INTERVALS = [
293 'millennia' => 31556952000,
294 'centuries' => 3155695200,
295 'decades' => 315569520,
296 'years' => 31556952, // 86400 * ( 365 + ( 24 * 3 + 25 ) / 400 )
297 'weeks' => 604800,
298 'days' => 86400,
299 'hours' => 3600,
300 'minutes' => 60,
301 'seconds' => 1,
305 * @deprecated since 1.35, use the DURATION_INTERVALS constant
306 * @since 1.20
307 * @var array
309 public static $durationIntervals = self::DURATION_INTERVALS;
312 * Unicode directional formatting characters, for embedBidi()
314 private const LRE = "\u{202A}"; // U+202A LEFT-TO-RIGHT EMBEDDING
315 private const RLE = "\u{202B}"; // U+202B RIGHT-TO-LEFT EMBEDDING
316 private const PDF = "\u{202C}"; // U+202C POP DIRECTIONAL FORMATTING
319 * Directionality test regex for embedBidi(). Matches the first strong directionality codepoint:
320 * - in group 1 if it is LTR
321 * - in group 2 if it is RTL
322 * Does not match if there is no strong directionality codepoint.
324 * The form is '/(?:([strong ltr codepoint])|([strong rtl codepoint]))/u' .
326 * Generated by UnicodeJS (see tools/strongDir) from the UCD; see
327 * https://phabricator.wikimedia.org/diffusion/GUJS/ .
329 // @codeCoverageIgnoreStart
330 // phpcs:ignore Generic.Files.LineLength
331 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';
332 // @codeCoverageIgnoreEnd
335 * Get a cached or new language object for a given language code
336 * @deprecated since 1.35, use LanguageFactory
337 * @param string $code
338 * @throws MWException if the language code is invalid
339 * @return Language
341 public static function factory( $code ) {
342 return MediaWikiServices::getInstance()->getLanguageFactory()->getLanguage( $code );
346 * Intended for tests that may change configuration in a way that invalidates caches.
348 * @since 1.32
349 * @deprecated since 1.35. Instead, reset all services and set Language::$mLangObjCache = [].
351 public static function clearCaches() {
352 wfDeprecated( __METHOD__, '1.35' );
354 $services = MediaWikiServices::getInstance();
356 $services->resetServiceForTesting( 'LanguageFallback' );
357 $services->resetServiceForTesting( 'LanguageNameUtils' );
358 $services->resetServiceForTesting( 'LocalisationCache' );
359 $services->resetServiceForTesting( 'LanguageFactory' );
361 self::$mLangObjCache = [];
365 * Checks whether any localisation is available for that language tag
366 * in MediaWiki (MessagesXx.php exists).
368 * @deprecated since 1.34, use LanguageNameUtils
369 * @param string $code Language tag (in lower case)
370 * @return bool Whether language is supported
371 * @since 1.21
373 public static function isSupportedLanguage( $code ) {
374 return MediaWikiServices::getInstance()->getLanguageNameUtils()
375 ->isSupportedLanguage( $code );
379 * Returns true if a language code string is a well-formed language tag
380 * according to RFC 5646.
381 * This function only checks well-formedness; it doesn't check that
382 * language, script or variant codes actually exist in the repositories.
384 * Based on regexes by Mark Davis of the Unicode Consortium:
385 * https://www.unicode.org/repos/cldr/trunk/tools/java/org/unicode/cldr/util/data/langtagRegex.txt
387 * @param string $code
388 * @param bool $lenient Whether to allow '_' as separator. The default is only '-'.
390 * @return bool
391 * @since 1.21
393 public static function isWellFormedLanguageTag( $code, $lenient = false ) {
394 $alpha = '[a-z]';
395 $digit = '[0-9]';
396 $alphanum = '[a-z0-9]';
397 $x = 'x'; # private use singleton
398 $singleton = '[a-wy-z]'; # other singleton
399 $s = $lenient ? '[-_]' : '-';
401 $language = "$alpha{2,8}|$alpha{2,3}$s$alpha{3}";
402 $script = "$alpha{4}"; # ISO 15924
403 $region = "(?:$alpha{2}|$digit{3})"; # ISO 3166-1 alpha-2 or UN M.49
404 $variant = "(?:$alphanum{5,8}|$digit$alphanum{3})";
405 $extension = "$singleton(?:$s$alphanum{2,8})+";
406 $privateUse = "$x(?:$s$alphanum{1,8})+";
408 # Define certain grandfathered codes, since otherwise the regex is pretty useless.
409 # Since these are limited, this is safe even later changes to the registry --
410 # the only oddity is that it might change the type of the tag, and thus
411 # the results from the capturing groups.
412 # https://www.iana.org/assignments/language-subtag-registry
414 $grandfathered = "en{$s}GB{$s}oed"
415 . "|i{$s}(?:ami|bnn|default|enochian|hak|klingon|lux|mingo|navajo|pwn|tao|tay|tsu)"
416 . "|no{$s}(?:bok|nyn)"
417 . "|sgn{$s}(?:BE{$s}(?:fr|nl)|CH{$s}de)"
418 . "|zh{$s}min{$s}nan";
420 $variantList = "$variant(?:$s$variant)*";
421 $extensionList = "$extension(?:$s$extension)*";
423 $langtag = "(?:($language)"
424 . "(?:$s$script)?"
425 . "(?:$s$region)?"
426 . "(?:$s$variantList)?"
427 . "(?:$s$extensionList)?"
428 . "(?:$s$privateUse)?)";
430 # The final breakdown, with capturing groups for each of these components
431 # The variants, extensions, grandfathered, and private-use may have interior '-'
433 $root = "^(?:$langtag|$privateUse|$grandfathered)$";
435 return (bool)preg_match( "/$root/", strtolower( $code ) );
439 * Returns true if a language code string is of a valid form, whether or
440 * not it exists. This includes codes which are used solely for
441 * customisation via the MediaWiki namespace.
443 * @deprecated since 1.34, use LanguageNameUtils
445 * @param string $code
447 * @return bool False if the language code contains dangerous characters, e.g. HTML special
448 * characters or characters illegal in MediaWiki titles.
450 public static function isValidCode( $code ) {
451 return MediaWikiServices::getInstance()->getLanguageNameUtils()->isValidCode( $code );
455 * Returns true if a language code is of a valid form for the purposes of
456 * internal customisation of MediaWiki, via Messages*.php or *.json.
458 * @deprecated since 1.34, use LanguageNameUtils
460 * @param string $code
462 * @since 1.18
463 * @return bool
465 public static function isValidBuiltInCode( $code ) {
466 return MediaWikiServices::getInstance()->getLanguageNameUtils()
467 ->isValidBuiltInCode( $code );
471 * Returns true if a language code is an IETF tag known to MediaWiki.
473 * @deprecated since 1.34, use LanguageNameUtils
475 * @param string $tag
477 * @since 1.21
478 * @return bool
480 public static function isKnownLanguageTag( $tag ) {
481 return MediaWikiServices::getInstance()->getLanguageNameUtils()
482 ->isKnownLanguageTag( $tag );
486 * @deprecated since 1.34, use MediaWikiServices
487 * @return LocalisationCache
489 public static function getLocalisationCache() {
490 return MediaWikiServices::getInstance()->getLocalisationCache();
494 * @internal Calling this directly is deprecated. Use LanguageFactory instead.
496 * @param string|null $code Which code to use. Passing null is deprecated in 1.35.
497 * @param LocalisationCache|null $localisationCache
498 * @param LanguageNameUtils|null $langNameUtils
499 * @param LanguageFallback|null $langFallback
500 * @param LanguageConverterFactory|null $converterFactory
501 * @param HookContainer|null $hookContainer
503 public function __construct(
504 $code = null,
505 LocalisationCache $localisationCache = null,
506 LanguageNameUtils $langNameUtils = null,
507 LanguageFallback $langFallback = null,
508 LanguageConverterFactory $converterFactory = null,
509 HookContainer $hookContainer = null
511 if ( !func_num_args() ) {
512 // Old calling convention, deprecated
513 if ( static::class === 'Language' ) {
514 $this->mCode = 'en';
515 } else {
516 $this->mCode = str_replace( '_', '-', strtolower( substr( static::class, 8 ) ) );
519 $services = MediaWikiServices::getInstance();
520 $this->localisationCache = $services->getLocalisationCache();
521 $this->langNameUtils = $services->getLanguageNameUtils();
522 $this->langFallback = $services->getLanguageFallback();
523 $this->converterFactory = $services->getLanguageConverterFactory();
524 $this->hookContainer = $services->getHookContainer();
525 $this->hookRunner = new HookRunner( $this->hookContainer );
526 return;
529 Assert::parameter( $code !== null, '$code',
530 'Parameters cannot be null unless all are omitted' );
531 Assert::parameter( $localisationCache !== null, '$localisationCache',
532 'Parameters cannot be null unless all are omitted' );
533 Assert::parameter( $langNameUtils !== null, '$langNameUtils',
534 'Parameters cannot be null unless all are omitted' );
535 Assert::parameter( $langFallback !== null, '$langFallback',
536 'Parameters cannot be null unless all are omitted' );
537 Assert::parameter( $converterFactory !== null, '$converterFactory',
538 'Parameters cannot be null unless all are omitted' );
539 Assert::parameter( $hookContainer !== null, '$hookContainer',
540 'Parameters cannot be null unless all are omitted' );
542 $this->mCode = $code;
543 $this->localisationCache = $localisationCache;
544 $this->langNameUtils = $langNameUtils;
545 $this->langFallback = $langFallback;
546 $this->converterFactory = $converterFactory;
547 $this->hookContainer = $hookContainer;
548 $this->hookRunner = new HookRunner( $hookContainer );
552 * Reduce memory usage
553 * @suppress PhanTypeSuspiciousNonTraversableForeach
555 public function __destruct() {
556 foreach ( $this as $name => $value ) {
557 unset( $this->$name );
562 * @return array
563 * @since 1.19
565 public function getFallbackLanguages() {
566 return $this->langFallback->getAll( $this->mCode );
570 * Exports $wgBookstoreListEn
571 * @return array
573 public function getBookstoreList() {
574 return $this->localisationCache->getItem( $this->mCode, 'bookstoreList' );
578 * Returns an array of localised namespaces indexed by their numbers. If the namespace is not
579 * available in localised form, it will be included in English.
581 * @return string[] List of localized namespace names, indexed by numeric namespace ID.
583 public function getNamespaces() {
584 if ( $this->namespaceNames === null ) {
585 global $wgMetaNamespace, $wgMetaNamespaceTalk, $wgExtraNamespaces;
587 $validNamespaces = MediaWikiServices::getInstance()->getNamespaceInfo()->
588 getCanonicalNamespaces();
590 $this->namespaceNames = $wgExtraNamespaces +
591 $this->localisationCache->getItem( $this->mCode, 'namespaceNames' );
592 $this->namespaceNames += $validNamespaces;
594 $this->namespaceNames[NS_PROJECT] = $wgMetaNamespace;
595 if ( $wgMetaNamespaceTalk ) {
596 $this->namespaceNames[NS_PROJECT_TALK] = $wgMetaNamespaceTalk;
597 } else {
598 $talk = $this->namespaceNames[NS_PROJECT_TALK];
599 $this->namespaceNames[NS_PROJECT_TALK] =
600 $this->fixVariableInNamespace( $talk );
603 # Sometimes a language will be localised but not actually exist on this wiki.
604 foreach ( $this->namespaceNames as $key => $text ) {
605 if ( !isset( $validNamespaces[$key] ) ) {
606 unset( $this->namespaceNames[$key] );
610 # The above mixing may leave namespaces out of canonical order.
611 # Re-order by namespace ID number...
612 ksort( $this->namespaceNames );
614 $this->getHookRunner()->onLanguageGetNamespaces( $this->namespaceNames );
617 return $this->namespaceNames;
621 * Arbitrarily set all of the namespace names at once. Mainly used for testing
622 * @param array $namespaces Array of namespaces (id => name)
624 public function setNamespaces( array $namespaces ) {
625 $this->namespaceNames = $namespaces;
626 $this->mNamespaceIds = null;
630 * Resets all of the namespace caches. Mainly used for testing
632 public function resetNamespaces() {
633 $this->namespaceNames = null;
634 $this->mNamespaceIds = null;
635 $this->namespaceAliases = null;
639 * A convenience function that returns getNamespaces() with spaces instead of underscores
640 * in values. Useful for producing output to be displayed e.g. in `<select>` forms.
642 * @return array
644 public function getFormattedNamespaces() {
645 $ns = $this->getNamespaces();
646 foreach ( $ns as $k => $v ) {
647 $ns[$k] = strtr( $v, '_', ' ' );
649 return $ns;
653 * Get a namespace value by key
655 * <code>
656 * $mw_ns = $lang->getNsText( NS_MEDIAWIKI );
657 * echo $mw_ns; // prints 'MediaWiki'
658 * </code>
660 * @param int $index The array key of the namespace to return
661 * @return string|bool String if the namespace value exists, otherwise false
663 public function getNsText( $index ) {
664 $ns = $this->getNamespaces();
665 return $ns[$index] ?? false;
669 * A convenience function that returns the same thing as
670 * getNsText() except with '_' changed to ' ', useful for
671 * producing output.
673 * <code>
674 * $mw_ns = $lang->getFormattedNsText( NS_MEDIAWIKI_TALK );
675 * echo $mw_ns; // prints 'MediaWiki talk'
676 * </code>
678 * @param int $index The array key of the namespace to return
679 * @return string Namespace name without underscores (empty string if namespace does not exist)
681 public function getFormattedNsText( $index ) {
682 $ns = $this->getNsText( $index );
683 return strtr( $ns, '_', ' ' );
687 * Returns gender-dependent namespace alias if available.
688 * See https://www.mediawiki.org/wiki/Manual:$wgExtraGenderNamespaces
689 * @param int $index Namespace index
690 * @param string $gender Gender key (male, female... )
691 * @return string
692 * @since 1.18
694 public function getGenderNsText( $index, $gender ) {
695 global $wgExtraGenderNamespaces;
697 $ns = $wgExtraGenderNamespaces +
698 (array)$this->localisationCache->getItem( $this->mCode, 'namespaceGenderAliases' );
700 return $ns[$index][$gender] ?? $this->getNsText( $index );
704 * Whether this language uses gender-dependent namespace aliases.
705 * See https://www.mediawiki.org/wiki/Manual:$wgExtraGenderNamespaces
706 * @return bool
707 * @since 1.18
709 public function needsGenderDistinction() {
710 global $wgExtraGenderNamespaces, $wgExtraNamespaces;
711 if ( count( $wgExtraGenderNamespaces ) > 0 ) {
712 // $wgExtraGenderNamespaces overrides everything
713 return true;
714 } elseif ( isset( $wgExtraNamespaces[NS_USER] ) && isset( $wgExtraNamespaces[NS_USER_TALK] ) ) {
715 /// @todo There may be other gender namespace than NS_USER & NS_USER_TALK in the future
716 // $wgExtraNamespaces overrides any gender aliases specified in i18n files
717 return false;
718 } else {
719 // Check what is in i18n files
720 $aliases = $this->localisationCache->getItem( $this->mCode, 'namespaceGenderAliases' );
721 return count( $aliases ) > 0;
726 * Get a namespace key by value, case insensitive.
727 * Only matches namespace names for the current language, not the
728 * canonical ones defined in Namespace.php.
730 * @param string $text
731 * @return int|false An integer if $text is a valid value otherwise false
733 public function getLocalNsIndex( $text ) {
734 $lctext = $this->lc( $text );
735 $ids = $this->getNamespaceIds();
736 return $ids[$lctext] ?? false;
740 * @return array<string,int> Map from names to namespace IDs. Note that each
741 * namepace ID can have multiple alias.
743 public function getNamespaceAliases() {
744 if ( $this->namespaceAliases === null ) {
745 $aliases = $this->localisationCache->getItem( $this->mCode, 'namespaceAliases' );
746 if ( !$aliases ) {
747 $aliases = [];
748 } else {
749 foreach ( $aliases as $name => $index ) {
750 if ( $index === NS_PROJECT_TALK ) {
751 unset( $aliases[$name] );
752 $name = $this->fixVariableInNamespace( $name );
753 $aliases[$name] = $index;
758 global $wgExtraGenderNamespaces;
759 $genders = $wgExtraGenderNamespaces + (array)$this->localisationCache
760 ->getItem( $this->mCode, 'namespaceGenderAliases' );
761 foreach ( $genders as $index => $forms ) {
762 foreach ( $forms as $alias ) {
763 $aliases[$alias] = $index;
767 # Also add converted namespace names as aliases, to avoid confusion.
768 $convertedNames = [];
769 foreach ( $this->getConverter()->getVariants() as $variant ) {
770 if ( $variant === $this->mCode ) {
771 continue;
773 foreach ( $this->getNamespaces() as $ns => $_ ) {
774 $convertedNames[$this->getConverter()->convertNamespace( $ns, $variant )] = $ns;
778 $this->namespaceAliases = $aliases + $convertedNames;
780 // In the case of conflicts between $wgNamespaceAliases and other sources
781 // of aliasing, $wgNamespaceAliases wins.
782 global $wgNamespaceAliases;
783 $this->namespaceAliases = $wgNamespaceAliases + $this->namespaceAliases;
785 # Filter out aliases to namespaces that don't exist, e.g. from extensions
786 # that aren't loaded here but are included in the l10n cache.
787 # (array_intersect preserves keys from its first argument)
788 $this->namespaceAliases = array_intersect(
789 $this->namespaceAliases,
790 array_keys( $this->getNamespaces() )
794 return $this->namespaceAliases;
798 * @return array
800 public function getNamespaceIds() {
801 if ( $this->mNamespaceIds === null ) {
802 # Put namespace names and aliases into a hashtable.
803 # If this is too slow, then we should arrange it so that it is done
804 # before caching. The catch is that at pre-cache time, the above
805 # class-specific fixup hasn't been done.
806 $this->mNamespaceIds = [];
807 foreach ( $this->getNamespaces() as $index => $name ) {
808 $this->mNamespaceIds[$this->lc( $name )] = $index;
810 foreach ( $this->getNamespaceAliases() as $name => $index ) {
811 $this->mNamespaceIds[$this->lc( $name )] = $index;
814 return $this->mNamespaceIds;
818 * Get a namespace key by value, case insensitive. Canonical namespace
819 * names override custom ones defined for the current language.
821 * @param string $text
822 * @return int|bool An integer if $text is a valid value otherwise false
824 public function getNsIndex( $text ) {
825 $lctext = $this->lc( $text );
826 $ns = MediaWikiServices::getInstance()->getNamespaceInfo()->
827 getCanonicalIndex( $lctext );
828 if ( $ns !== null ) {
829 return $ns;
831 $ids = $this->getNamespaceIds();
832 return $ids[$lctext] ?? false;
836 * short names for language variants used for language conversion links.
838 * @param string $code
839 * @param bool $usemsg Use the "variantname-xyz" message if it exists
840 * @return string
842 public function getVariantname( $code, $usemsg = true ) {
843 $msg = "variantname-$code";
844 if ( $usemsg && wfMessage( $msg )->exists() ) {
845 return $this->getMessageFromDB( $msg );
847 $name = $this->langNameUtils->getLanguageName( $code );
848 if ( $name ) {
849 return $name; # if it's defined as a language name, show that
850 } else {
851 # otherwise, output the language code
852 return $code;
857 * @return string[]|bool List of date format preference keys, or false if disabled.
859 public function getDatePreferences() {
860 return $this->localisationCache->getItem( $this->mCode, 'datePreferences' );
864 * @return array
866 public function getDateFormats() {
867 return $this->localisationCache->getItem( $this->mCode, 'dateFormats' );
871 * @return array|string
873 public function getDefaultDateFormat() {
874 $df = $this->localisationCache->getItem( $this->mCode, 'defaultDateFormat' );
875 if ( $df === 'dmy or mdy' ) {
876 global $wgAmericanDates;
877 return $wgAmericanDates ? 'mdy' : 'dmy';
878 } else {
879 return $df;
884 * @return array
886 public function getDatePreferenceMigrationMap() {
887 return $this->localisationCache->getItem( $this->mCode, 'datePreferenceMigrationMap' );
891 * Get an array of language names, indexed by code.
893 * @deprecated since 1.34, use LanguageNameUtils::getLanguageNames
894 * @param null|string $inLanguage Code of language in which to return the names
895 * Use LanguageNameUtils::AUTONYMS for autonyms (native names)
896 * @param string $include One of:
897 * LanguageNameUtils::AUTONYMS all available languages
898 * 'mw' only if the language is defined in MediaWiki
899 * or wgExtraLanguageNames (default)
900 * LanguageNameUtils::SUPPORTED only if the language is in 'mw' *and*
901 * has a message file
902 * @return array Language code => language name (sorted by key)
903 * @since 1.20
905 public static function fetchLanguageNames(
906 $inLanguage = LanguageNameUtils::AUTONYMS,
907 $include = 'mw'
909 return MediaWikiServices::getInstance()->getLanguageNameUtils()
910 ->getLanguageNames( $inLanguage, $include );
914 * @deprecated since 1.34, use LanguageNameUtils::getLanguageName
915 * @param string $code The code of the language for which to get the name
916 * @param null|string $inLanguage Code of language in which to return the name
917 * (LanguageNameUtils::AUTONYMS for autonyms)
918 * @param string $include See fetchLanguageNames()
919 * @return string Language name or empty
920 * @since 1.20
922 public static function fetchLanguageName(
923 $code,
924 $inLanguage = LanguageNameUtils::AUTONYMS,
925 $include = LanguageNameUtils::ALL
927 return MediaWikiServices::getInstance()->getLanguageNameUtils()
928 ->getLanguageName( $code, $inLanguage, $include );
932 * Get a message from the MediaWiki namespace.
934 * @param string $msg Message name
935 * @return string
937 public function getMessageFromDB( $msg ) {
938 return $this->msg( $msg )->text();
942 * Get message object in this language. Only for use inside this class.
944 * @param string $msg Message name
945 * @return Message
947 protected function msg( $msg ) {
948 return wfMessage( $msg )->inLanguage( $this );
952 * @param int $key
953 * @return string
955 public function getMonthName( $key ) {
956 return $this->getMessageFromDB( self::MONTH_MESSAGES[$key - 1] );
960 * @return array
962 public function getMonthNamesArray() {
963 $monthNames = [ '' ];
964 for ( $i = 1; $i < 13; $i++ ) {
965 $monthNames[] = $this->getMonthName( $i );
967 return $monthNames;
971 * @param int $key
972 * @return string
974 public function getMonthNameGen( $key ) {
975 return $this->getMessageFromDB( self::MONTH_GENITIVE_MESSAGES[$key - 1] );
979 * @param int $key
980 * @return string
982 public function getMonthAbbreviation( $key ) {
983 return $this->getMessageFromDB( self::MONTH_ABBREVIATED_MESSAGES[$key - 1] );
987 * @return array
989 public function getMonthAbbreviationsArray() {
990 $monthNames = [ '' ];
991 for ( $i = 1; $i < 13; $i++ ) {
992 $monthNames[] = $this->getMonthAbbreviation( $i );
994 return $monthNames;
998 * @param int $key
999 * @return string
1001 public function getWeekdayName( $key ) {
1002 return $this->getMessageFromDB( self::WEEKDAY_MESSAGES[$key - 1] );
1006 * @param int $key
1007 * @return string
1009 public function getWeekdayAbbreviation( $key ) {
1010 return $this->getMessageFromDB( self::WEEKDAY_ABBREVIATED_MESSAGES[$key - 1] );
1014 * @param int $key
1015 * @return string
1017 private function getIranianCalendarMonthName( $key ) {
1018 return $this->getMessageFromDB( self::IRANIAN_CALENDAR_MONTHS_MESSAGES[$key - 1] );
1022 * @param int $key
1023 * @return string
1025 private function getHebrewCalendarMonthName( $key ) {
1026 return $this->getMessageFromDB( self::HEBREW_CALENDAR_MONTHS_MESSAGES[$key - 1] );
1030 * @param int $key
1031 * @return string
1033 private function getHebrewCalendarMonthNameGen( $key ) {
1034 return $this->getMessageFromDB( self::HEBREW_CALENDAR_MONTH_GENITIVE_MESSAGES[$key - 1] );
1038 * @param int $key
1039 * @return string
1041 private function getHijriCalendarMonthName( $key ) {
1042 return $this->getMessageFromDB( self::HIJRI_CALENDAR_MONTH_MESSAGES[$key - 1] );
1046 * Pass through result from $dateTimeObj->format()
1047 * @param DateTime|bool|null &$dateTimeObj
1048 * @param string $ts
1049 * @param DateTimeZone|bool|null $zone
1050 * @param string $code
1051 * @return string
1053 private static function dateTimeObjFormat( &$dateTimeObj, $ts, $zone, $code ) {
1054 if ( !$dateTimeObj ) {
1055 $dateTimeObj = DateTime::createFromFormat(
1056 'YmdHis', $ts, $zone ?: new DateTimeZone( 'UTC' )
1059 return $dateTimeObj->format( $code );
1063 * This is a workalike of PHP's date() function, but with better
1064 * internationalisation, a reduced set of format characters, and a better
1065 * escaping format.
1067 * Supported format characters are dDjlNwzWFmMntLoYyaAgGhHiscrUeIOPTZ. See
1068 * the PHP manual for definitions. There are a number of extensions, which
1069 * start with "x":
1071 * xn Do not translate digits of the next numeric format character
1072 * xN Toggle raw digit (xn) flag, stays set until explicitly unset
1073 * xr Use roman numerals for the next numeric format character
1074 * xh Use hebrew numerals for the next numeric format character
1075 * xx Literal x
1076 * xg Genitive month name
1078 * xij j (day number) in Iranian calendar
1079 * xiF F (month name) in Iranian calendar
1080 * xin n (month number) in Iranian calendar
1081 * xiy y (two digit year) in Iranian calendar
1082 * xiY Y (full year) in Iranian calendar
1083 * xit t (days in month) in Iranian calendar
1084 * xiz z (day of the year) in Iranian calendar
1086 * xjj j (day number) in Hebrew calendar
1087 * xjF F (month name) in Hebrew calendar
1088 * xjt t (days in month) in Hebrew calendar
1089 * xjx xg (genitive month name) in Hebrew calendar
1090 * xjn n (month number) in Hebrew calendar
1091 * xjY Y (full year) in Hebrew calendar
1093 * xmj j (day number) in Hijri calendar
1094 * xmF F (month name) in Hijri calendar
1095 * xmn n (month number) in Hijri calendar
1096 * xmY Y (full year) in Hijri calendar
1098 * xkY Y (full year) in Thai solar calendar. Months and days are
1099 * identical to the Gregorian calendar
1100 * xoY Y (full year) in Minguo calendar or Juche year.
1101 * Months and days are identical to the
1102 * Gregorian calendar
1103 * xtY Y (full year) in Japanese nengo. Months and days are
1104 * identical to the Gregorian calendar
1106 * Characters enclosed in double quotes will be considered literal (with
1107 * the quotes themselves removed). Unmatched quotes will be considered
1108 * literal quotes. Example:
1110 * "The month is" F => The month is January
1111 * i's" => 20'11"
1113 * Backslash escaping is also supported.
1115 * Input timestamp is assumed to be pre-normalized to the desired local
1116 * time zone, if any. Note that the format characters crUeIOPTZ will assume
1117 * $ts is UTC if $zone is not given.
1119 * @param string $format
1120 * @param string $ts 14-character timestamp
1121 * YYYYMMDDHHMMSS
1122 * 01234567890123
1123 * @param DateTimeZone|null $zone Timezone of $ts
1124 * @param int|null &$ttl The amount of time (in seconds) the output may be cached for.
1125 * Only makes sense if $ts is the current time.
1126 * @todo handling of "o" format character for Iranian, Hebrew, Hijri & Thai?
1128 * @throws MWException
1129 * @return string
1130 * @return-taint tainted
1132 public function sprintfDate( $format, $ts, DateTimeZone $zone = null, &$ttl = 'unused' ) {
1133 $s = '';
1134 $raw = false;
1135 $roman = false;
1136 $hebrewNum = false;
1137 $dateTimeObj = false;
1138 $rawToggle = false;
1139 $iranian = false;
1140 $hebrew = false;
1141 $hijri = false;
1142 $thai = false;
1143 $minguo = false;
1144 $tenno = false;
1146 $usedSecond = false;
1147 $usedMinute = false;
1148 $usedHour = false;
1149 $usedAMPM = false;
1150 $usedDay = false;
1151 $usedWeek = false;
1152 $usedMonth = false;
1153 $usedYear = false;
1154 $usedISOYear = false;
1155 $usedIsLeapYear = false;
1157 $usedHebrewMonth = false;
1158 $usedIranianMonth = false;
1159 $usedHijriMonth = false;
1160 $usedHebrewYear = false;
1161 $usedIranianYear = false;
1162 $usedHijriYear = false;
1163 $usedTennoYear = false;
1165 if ( strlen( $ts ) !== 14 ) {
1166 throw new MWException( __METHOD__ . ": The timestamp $ts should have 14 characters" );
1169 if ( !ctype_digit( $ts ) ) {
1170 throw new MWException( __METHOD__ . ": The timestamp $ts should be a number" );
1173 $formatLength = strlen( $format );
1174 for ( $p = 0; $p < $formatLength; $p++ ) {
1175 $num = false;
1176 $code = $format[$p];
1177 if ( $code == 'x' && $p < $formatLength - 1 ) {
1178 $code .= $format[++$p];
1181 if ( ( $code === 'xi'
1182 || $code === 'xj'
1183 || $code === 'xk'
1184 || $code === 'xm'
1185 || $code === 'xo'
1186 || $code === 'xt' )
1187 && $p < $formatLength - 1 ) {
1188 $code .= $format[++$p];
1191 switch ( $code ) {
1192 case 'xx':
1193 $s .= 'x';
1194 break;
1195 case 'xn':
1196 $raw = true;
1197 break;
1198 case 'xN':
1199 $rawToggle = !$rawToggle;
1200 break;
1201 case 'xr':
1202 $roman = true;
1203 break;
1204 case 'xh':
1205 $hebrewNum = true;
1206 break;
1207 case 'xg':
1208 $usedMonth = true;
1209 $s .= $this->getMonthNameGen( substr( $ts, 4, 2 ) );
1210 break;
1211 case 'xjx':
1212 $usedHebrewMonth = true;
1213 if ( !$hebrew ) {
1214 $hebrew = self::tsToHebrew( $ts );
1216 $s .= $this->getHebrewCalendarMonthNameGen( $hebrew[1] );
1217 break;
1218 case 'd':
1219 $usedDay = true;
1220 $num = substr( $ts, 6, 2 );
1221 break;
1222 case 'D':
1223 $usedDay = true;
1224 $s .= $this->getWeekdayAbbreviation(
1225 self::dateTimeObjFormat( $dateTimeObj, $ts, $zone, 'w' ) + 1
1227 break;
1228 case 'j':
1229 $usedDay = true;
1230 $num = intval( substr( $ts, 6, 2 ) );
1231 break;
1232 case 'xij':
1233 $usedDay = true;
1234 if ( !$iranian ) {
1235 $iranian = self::tsToIranian( $ts );
1237 $num = $iranian[2];
1238 break;
1239 case 'xmj':
1240 $usedDay = true;
1241 if ( !$hijri ) {
1242 $hijri = self::tsToHijri( $ts );
1244 $num = $hijri[2];
1245 break;
1246 case 'xjj':
1247 $usedDay = true;
1248 if ( !$hebrew ) {
1249 $hebrew = self::tsToHebrew( $ts );
1251 $num = $hebrew[2];
1252 break;
1253 case 'l':
1254 $usedDay = true;
1255 $s .= $this->getWeekdayName(
1256 self::dateTimeObjFormat( $dateTimeObj, $ts, $zone, 'w' ) + 1
1258 break;
1259 case 'F':
1260 $usedMonth = true;
1261 $s .= $this->getMonthName( substr( $ts, 4, 2 ) );
1262 break;
1263 case 'xiF':
1264 $usedIranianMonth = true;
1265 if ( !$iranian ) {
1266 $iranian = self::tsToIranian( $ts );
1268 $s .= $this->getIranianCalendarMonthName( $iranian[1] );
1269 break;
1270 case 'xmF':
1271 $usedHijriMonth = true;
1272 if ( !$hijri ) {
1273 $hijri = self::tsToHijri( $ts );
1275 $s .= $this->getHijriCalendarMonthName( $hijri[1] );
1276 break;
1277 case 'xjF':
1278 $usedHebrewMonth = true;
1279 if ( !$hebrew ) {
1280 $hebrew = self::tsToHebrew( $ts );
1282 $s .= $this->getHebrewCalendarMonthName( $hebrew[1] );
1283 break;
1284 case 'm':
1285 $usedMonth = true;
1286 $num = substr( $ts, 4, 2 );
1287 break;
1288 case 'M':
1289 $usedMonth = true;
1290 $s .= $this->getMonthAbbreviation( substr( $ts, 4, 2 ) );
1291 break;
1292 case 'n':
1293 $usedMonth = true;
1294 $num = intval( substr( $ts, 4, 2 ) );
1295 break;
1296 case 'xin':
1297 $usedIranianMonth = true;
1298 if ( !$iranian ) {
1299 $iranian = self::tsToIranian( $ts );
1301 $num = $iranian[1];
1302 break;
1303 case 'xmn':
1304 $usedHijriMonth = true;
1305 if ( !$hijri ) {
1306 $hijri = self::tsToHijri( $ts );
1308 $num = $hijri[1];
1309 break;
1310 case 'xjn':
1311 $usedHebrewMonth = true;
1312 if ( !$hebrew ) {
1313 $hebrew = self::tsToHebrew( $ts );
1315 $num = $hebrew[1];
1316 break;
1317 case 'xjt':
1318 $usedHebrewMonth = true;
1319 if ( !$hebrew ) {
1320 $hebrew = self::tsToHebrew( $ts );
1322 $num = $hebrew[3];
1323 break;
1324 case 'Y':
1325 $usedYear = true;
1326 $num = substr( $ts, 0, 4 );
1327 break;
1328 case 'xiY':
1329 $usedIranianYear = true;
1330 if ( !$iranian ) {
1331 $iranian = self::tsToIranian( $ts );
1333 $num = $iranian[0];
1334 break;
1335 case 'xmY':
1336 $usedHijriYear = true;
1337 if ( !$hijri ) {
1338 $hijri = self::tsToHijri( $ts );
1340 $num = $hijri[0];
1341 break;
1342 case 'xjY':
1343 $usedHebrewYear = true;
1344 if ( !$hebrew ) {
1345 $hebrew = self::tsToHebrew( $ts );
1347 $num = $hebrew[0];
1348 break;
1349 case 'xkY':
1350 $usedYear = true;
1351 if ( !$thai ) {
1352 $thai = self::tsToYear( $ts, 'thai' );
1354 $num = $thai[0];
1355 break;
1356 case 'xoY':
1357 $usedYear = true;
1358 if ( !$minguo ) {
1359 $minguo = self::tsToYear( $ts, 'minguo' );
1361 $num = $minguo[0];
1362 break;
1363 case 'xtY':
1364 $usedTennoYear = true;
1365 if ( !$tenno ) {
1366 $tenno = self::tsToYear( $ts, 'tenno' );
1368 $num = $tenno[0];
1369 break;
1370 case 'y':
1371 $usedYear = true;
1372 $num = substr( $ts, 2, 2 );
1373 break;
1374 case 'xiy':
1375 $usedIranianYear = true;
1376 if ( !$iranian ) {
1377 $iranian = self::tsToIranian( $ts );
1379 $num = substr( $iranian[0], -2 );
1380 break;
1381 case 'xit':
1382 $usedIranianYear = true;
1383 if ( !$iranian ) {
1384 $iranian = self::tsToIranian( $ts );
1386 $num = self::$IRANIAN_DAYS[$iranian[1] - 1];
1387 break;
1388 case 'xiz':
1389 $usedIranianYear = true;
1390 if ( !$iranian ) {
1391 $iranian = self::tsToIranian( $ts );
1393 $num = $iranian[3];
1394 break;
1395 case 'a':
1396 $usedAMPM = true;
1397 $s .= intval( substr( $ts, 8, 2 ) ) < 12 ? 'am' : 'pm';
1398 break;
1399 case 'A':
1400 $usedAMPM = true;
1401 $s .= intval( substr( $ts, 8, 2 ) ) < 12 ? 'AM' : 'PM';
1402 break;
1403 case 'g':
1404 $usedHour = true;
1405 $h = substr( $ts, 8, 2 );
1406 $num = $h % 12 ?: 12;
1407 break;
1408 case 'G':
1409 $usedHour = true;
1410 $num = intval( substr( $ts, 8, 2 ) );
1411 break;
1412 case 'h':
1413 $usedHour = true;
1414 $h = substr( $ts, 8, 2 );
1415 $num = sprintf( '%02d', $h % 12 ?: 12 );
1416 break;
1417 case 'H':
1418 $usedHour = true;
1419 $num = substr( $ts, 8, 2 );
1420 break;
1421 case 'i':
1422 $usedMinute = true;
1423 $num = substr( $ts, 10, 2 );
1424 break;
1425 case 's':
1426 $usedSecond = true;
1427 $num = substr( $ts, 12, 2 );
1428 break;
1429 case 'c':
1430 case 'r':
1431 $usedSecond = true;
1432 // fall through
1433 case 'e':
1434 case 'O':
1435 case 'P':
1436 case 'T':
1437 $s .= self::dateTimeObjFormat( $dateTimeObj, $ts, $zone, $code );
1438 break;
1439 case 'w':
1440 case 'N':
1441 case 'z':
1442 $usedDay = true;
1443 $num = self::dateTimeObjFormat( $dateTimeObj, $ts, $zone, $code );
1444 break;
1445 case 'W':
1446 $usedWeek = true;
1447 $num = self::dateTimeObjFormat( $dateTimeObj, $ts, $zone, $code );
1448 break;
1449 case 't':
1450 $usedMonth = true;
1451 $num = self::dateTimeObjFormat( $dateTimeObj, $ts, $zone, $code );
1452 break;
1453 case 'L':
1454 $usedIsLeapYear = true;
1455 $num = self::dateTimeObjFormat( $dateTimeObj, $ts, $zone, $code );
1456 break;
1457 case 'o':
1458 $usedISOYear = true;
1459 $num = self::dateTimeObjFormat( $dateTimeObj, $ts, $zone, $code );
1460 break;
1461 case 'U':
1462 $usedSecond = true;
1463 // fall through
1464 case 'I':
1465 case 'Z':
1466 $num = self::dateTimeObjFormat( $dateTimeObj, $ts, $zone, $code );
1467 break;
1468 case '\\':
1469 # Backslash escaping
1470 if ( $p < $formatLength - 1 ) {
1471 $s .= $format[++$p];
1472 } else {
1473 $s .= '\\';
1475 break;
1476 case '"':
1477 # Quoted literal
1478 if ( $p < $formatLength - 1 ) {
1479 $endQuote = strpos( $format, '"', $p + 1 );
1480 if ( $endQuote === false ) {
1481 # No terminating quote, assume literal "
1482 $s .= '"';
1483 } else {
1484 $s .= substr( $format, $p + 1, $endQuote - $p - 1 );
1485 $p = $endQuote;
1487 } else {
1488 # Quote at end of string, assume literal "
1489 $s .= '"';
1491 break;
1492 default:
1493 $s .= $format[$p];
1495 if ( $num !== false ) {
1496 if ( $rawToggle || $raw ) {
1497 $s .= $num;
1498 $raw = false;
1499 } elseif ( $roman ) {
1500 $s .= self::romanNumeral( $num );
1501 $roman = false;
1502 } elseif ( $hebrewNum ) {
1503 $s .= self::hebrewNumeral( $num );
1504 $hebrewNum = false;
1505 } elseif ( preg_match( '/^[\d.]+$/', $num ) ) {
1506 $s .= $this->formatNumNoSeparators( $num );
1507 } else {
1508 $s .= $num;
1513 if ( $ttl === 'unused' ) {
1514 // No need to calculate the TTL, the caller wont use it anyway.
1515 } elseif ( $usedSecond ) {
1516 $ttl = 1;
1517 } elseif ( $usedMinute ) {
1518 $ttl = 60 - substr( $ts, 12, 2 );
1519 } elseif ( $usedHour ) {
1520 $ttl = 3600 - substr( $ts, 10, 2 ) * 60 - substr( $ts, 12, 2 );
1521 } elseif ( $usedAMPM ) {
1522 $ttl = 43200 - ( substr( $ts, 8, 2 ) % 12 ) * 3600 -
1523 substr( $ts, 10, 2 ) * 60 - substr( $ts, 12, 2 );
1524 } elseif (
1525 $usedDay ||
1526 $usedHebrewMonth ||
1527 $usedIranianMonth ||
1528 $usedHijriMonth ||
1529 $usedHebrewYear ||
1530 $usedIranianYear ||
1531 $usedHijriYear ||
1532 $usedTennoYear
1534 // @todo Someone who understands the non-Gregorian calendars
1535 // should write proper logic for them so that they don't need purged every day.
1536 $ttl = 86400 - substr( $ts, 8, 2 ) * 3600 -
1537 substr( $ts, 10, 2 ) * 60 - substr( $ts, 12, 2 );
1538 } else {
1539 $possibleTtls = [];
1540 $timeRemainingInDay = 86400 - substr( $ts, 8, 2 ) * 3600 -
1541 substr( $ts, 10, 2 ) * 60 - substr( $ts, 12, 2 );
1542 if ( $usedWeek ) {
1543 $possibleTtls[] =
1544 ( 7 - self::dateTimeObjFormat( $dateTimeObj, $ts, $zone, 'N' ) ) * 86400 +
1545 $timeRemainingInDay;
1546 } elseif ( $usedISOYear ) {
1547 // December 28th falls on the last ISO week of the year, every year.
1548 // The last ISO week of a year can be 52 or 53.
1549 $lastWeekOfISOYear = DateTime::createFromFormat(
1550 'Ymd',
1551 substr( $ts, 0, 4 ) . '1228',
1552 $zone ?: new DateTimeZone( 'UTC' )
1553 )->format( 'W' );
1554 $currentISOWeek = self::dateTimeObjFormat( $dateTimeObj, $ts, $zone, 'W' );
1555 $weeksRemaining = $lastWeekOfISOYear - $currentISOWeek;
1556 $timeRemainingInWeek =
1557 ( 7 - self::dateTimeObjFormat( $dateTimeObj, $ts, $zone, 'N' ) ) * 86400
1558 + $timeRemainingInDay;
1559 $possibleTtls[] = $weeksRemaining * 604800 + $timeRemainingInWeek;
1562 if ( $usedMonth ) {
1563 $possibleTtls[] =
1564 ( self::dateTimeObjFormat( $dateTimeObj, $ts, $zone, 't' ) -
1565 substr( $ts, 6, 2 ) ) * 86400
1566 + $timeRemainingInDay;
1567 } elseif ( $usedYear ) {
1568 $possibleTtls[] =
1569 ( self::dateTimeObjFormat( $dateTimeObj, $ts, $zone, 'L' ) + 364 -
1570 self::dateTimeObjFormat( $dateTimeObj, $ts, $zone, 'z' ) ) * 86400
1571 + $timeRemainingInDay;
1572 } elseif ( $usedIsLeapYear ) {
1573 $year = substr( $ts, 0, 4 );
1574 $timeRemainingInYear =
1575 ( self::dateTimeObjFormat( $dateTimeObj, $ts, $zone, 'L' ) + 364 -
1576 self::dateTimeObjFormat( $dateTimeObj, $ts, $zone, 'z' ) ) * 86400
1577 + $timeRemainingInDay;
1578 $mod = $year % 4;
1579 if ( $mod || ( !( $year % 100 ) && $year % 400 ) ) {
1580 // this isn't a leap year. see when the next one starts
1581 $nextCandidate = $year - $mod + 4;
1582 if ( $nextCandidate % 100 || !( $nextCandidate % 400 ) ) {
1583 $possibleTtls[] = ( $nextCandidate - $year - 1 ) * 365 * 86400 +
1584 $timeRemainingInYear;
1585 } else {
1586 $possibleTtls[] = ( $nextCandidate - $year + 3 ) * 365 * 86400 +
1587 $timeRemainingInYear;
1589 } else {
1590 // this is a leap year, so the next year isn't
1591 $possibleTtls[] = $timeRemainingInYear;
1595 if ( $possibleTtls ) {
1596 $ttl = min( $possibleTtls );
1600 return $s;
1603 private static $GREG_DAYS = [ 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 ];
1604 private static $IRANIAN_DAYS = [ 31, 31, 31, 31, 31, 31, 30, 30, 30, 30, 30, 29 ];
1607 * Algorithm by Roozbeh Pournader and Mohammad Toossi to convert
1608 * Gregorian dates to Iranian dates. Originally written in C, it
1609 * is released under the terms of GNU Lesser General Public
1610 * License. Conversion to PHP was performed by Niklas Laxström.
1612 * Link: http://www.farsiweb.info/jalali/jalali.c
1614 * @param string $ts
1616 * @return int[]
1618 private static function tsToIranian( $ts ) {
1619 $gy = substr( $ts, 0, 4 ) - 1600;
1620 $gm = substr( $ts, 4, 2 ) - 1;
1621 $gd = substr( $ts, 6, 2 ) - 1;
1623 # Days passed from the beginning (including leap years)
1624 $gDayNo = 365 * $gy
1625 + floor( ( $gy + 3 ) / 4 )
1626 - floor( ( $gy + 99 ) / 100 )
1627 + floor( ( $gy + 399 ) / 400 );
1629 // Add days of the past months of this year
1630 for ( $i = 0; $i < $gm; $i++ ) {
1631 $gDayNo += self::$GREG_DAYS[$i];
1634 // Leap years
1635 if ( $gm > 1 && ( ( $gy % 4 === 0 && $gy % 100 !== 0 || ( $gy % 400 == 0 ) ) ) ) {
1636 $gDayNo++;
1639 // Days passed in current month
1640 $gDayNo += (int)$gd;
1642 $jDayNo = $gDayNo - 79;
1644 $jNp = floor( $jDayNo / 12053 );
1645 $jDayNo %= 12053;
1647 $jy = 979 + 33 * $jNp + 4 * floor( $jDayNo / 1461 );
1648 $jDayNo %= 1461;
1650 if ( $jDayNo >= 366 ) {
1651 $jy += floor( ( $jDayNo - 1 ) / 365 );
1652 $jDayNo = floor( ( $jDayNo - 1 ) % 365 );
1655 $jz = $jDayNo;
1657 for ( $i = 0; $i < 11 && $jDayNo >= self::$IRANIAN_DAYS[$i]; $i++ ) {
1658 $jDayNo -= self::$IRANIAN_DAYS[$i];
1661 $jm = $i + 1;
1662 $jd = $jDayNo + 1;
1664 return [ $jy, $jm, $jd, $jz ];
1668 * Converting Gregorian dates to Hijri dates.
1670 * Based on a PHP-Nuke block by Sharjeel which is released under GNU/GPL license
1672 * @see https://phpnuke.org/modules.php?name=News&file=article&sid=8234&mode=thread&order=0&thold=0
1674 * @param string $ts
1676 * @return int[]
1678 private static function tsToHijri( $ts ) {
1679 $year = substr( $ts, 0, 4 );
1680 $month = substr( $ts, 4, 2 );
1681 $day = substr( $ts, 6, 2 );
1683 $zyr = $year;
1684 $zd = $day;
1685 $zm = $month;
1686 $zy = $zyr;
1688 if (
1689 ( $zy > 1582 ) || ( ( $zy == 1582 ) && ( $zm > 10 ) ) ||
1690 ( ( $zy == 1582 ) && ( $zm == 10 ) && ( $zd > 14 ) )
1692 $zjd = (int)( ( 1461 * ( $zy + 4800 + (int)( ( $zm - 14 ) / 12 ) ) ) / 4 ) +
1693 (int)( ( 367 * ( $zm - 2 - 12 * ( (int)( ( $zm - 14 ) / 12 ) ) ) ) / 12 ) -
1694 (int)( ( 3 * (int)( ( ( $zy + 4900 + (int)( ( $zm - 14 ) / 12 ) ) / 100 ) ) ) / 4 ) +
1695 $zd - 32075;
1696 } else {
1697 $zjd = 367 * $zy - (int)( ( 7 * ( $zy + 5001 + (int)( ( $zm - 9 ) / 7 ) ) ) / 4 ) +
1698 (int)( ( 275 * $zm ) / 9 ) + $zd + 1729777;
1701 $zl = $zjd - 1948440 + 10632;
1702 $zn = (int)( ( $zl - 1 ) / 10631 );
1703 $zl = $zl - 10631 * $zn + 354;
1704 $zj = ( (int)( ( 10985 - $zl ) / 5316 ) ) * ( (int)( ( 50 * $zl ) / 17719 ) ) +
1705 ( (int)( $zl / 5670 ) ) * ( (int)( ( 43 * $zl ) / 15238 ) );
1706 $zl = $zl - ( (int)( ( 30 - $zj ) / 15 ) ) * ( (int)( ( 17719 * $zj ) / 50 ) ) -
1707 ( (int)( $zj / 16 ) ) * ( (int)( ( 15238 * $zj ) / 43 ) ) + 29;
1708 $zm = (int)( ( 24 * $zl ) / 709 );
1709 $zd = $zl - (int)( ( 709 * $zm ) / 24 );
1710 $zy = 30 * $zn + $zj - 30;
1712 return [ $zy, $zm, $zd ];
1716 * Converting Gregorian dates to Hebrew dates.
1718 * Based on a JavaScript code by Abu Mami and Yisrael Hersch
1719 * (abu-mami@kaluach.net, http://www.kaluach.net), who permitted
1720 * to translate the relevant functions into PHP and release them under
1721 * GNU GPL.
1723 * The months are counted from Tishrei = 1. In a leap year, Adar I is 13
1724 * and Adar II is 14. In a non-leap year, Adar is 6.
1726 * @param string $ts
1728 * @return int[]
1730 private static function tsToHebrew( $ts ) {
1731 # Parse date
1732 $year = substr( $ts, 0, 4 );
1733 $month = substr( $ts, 4, 2 );
1734 $day = substr( $ts, 6, 2 );
1736 # Calculate Hebrew year
1737 $hebrewYear = $year + 3760;
1739 # Month number when September = 1, August = 12
1740 $month += 4;
1741 if ( $month > 12 ) {
1742 # Next year
1743 $month -= 12;
1744 $year++;
1745 $hebrewYear++;
1748 # Calculate day of year from 1 September
1749 $dayOfYear = $day;
1750 for ( $i = 1; $i < $month; $i++ ) {
1751 if ( $i == 6 ) {
1752 # February
1753 $dayOfYear += 28;
1754 # Check if the year is leap
1755 if ( $year % 400 == 0 || ( $year % 4 == 0 && $year % 100 > 0 ) ) {
1756 $dayOfYear++;
1758 } elseif ( $i == 8 || $i == 10 || $i == 1 || $i == 3 ) {
1759 $dayOfYear += 30;
1760 } else {
1761 $dayOfYear += 31;
1765 # Calculate the start of the Hebrew year
1766 $start = self::hebrewYearStart( $hebrewYear );
1768 # Calculate next year's start
1769 if ( $dayOfYear <= $start ) {
1770 # Day is before the start of the year - it is the previous year
1771 # Next year's start
1772 $nextStart = $start;
1773 # Previous year
1774 $year--;
1775 $hebrewYear--;
1776 # Add days since previous year's 1 September
1777 $dayOfYear += 365;
1778 if ( ( $year % 400 == 0 ) || ( $year % 100 != 0 && $year % 4 == 0 ) ) {
1779 # Leap year
1780 $dayOfYear++;
1782 # Start of the new (previous) year
1783 $start = self::hebrewYearStart( $hebrewYear );
1784 } else {
1785 # Next year's start
1786 $nextStart = self::hebrewYearStart( $hebrewYear + 1 );
1789 # Calculate Hebrew day of year
1790 $hebrewDayOfYear = $dayOfYear - $start;
1792 # Difference between year's days
1793 $diff = $nextStart - $start;
1794 # Add 12 (or 13 for leap years) days to ignore the difference between
1795 # Hebrew and Gregorian year (353 at least vs. 365/6) - now the
1796 # difference is only about the year type
1797 if ( ( $year % 400 == 0 ) || ( $year % 100 != 0 && $year % 4 == 0 ) ) {
1798 $diff += 13;
1799 } else {
1800 $diff += 12;
1803 # Check the year pattern, and is leap year
1804 # 0 means an incomplete year, 1 means a regular year, 2 means a complete year
1805 # This is mod 30, to work on both leap years (which add 30 days of Adar I)
1806 # and non-leap years
1807 $yearPattern = $diff % 30;
1808 # Check if leap year
1809 $isLeap = $diff >= 30;
1811 # Calculate day in the month from number of day in the Hebrew year
1812 # Don't check Adar - if the day is not in Adar, we will stop before;
1813 # if it is in Adar, we will use it to check if it is Adar I or Adar II
1814 $hebrewDay = $hebrewDayOfYear;
1815 $hebrewMonth = 1;
1816 $days = 0;
1817 while ( $hebrewMonth <= 12 ) {
1818 # Calculate days in this month
1819 if ( $isLeap && $hebrewMonth == 6 ) {
1820 # Leap year - has Adar I, with 30 days, and Adar II, with 29 days
1821 $days = 30;
1822 if ( $hebrewDay <= $days ) {
1823 # Day in Adar I
1824 $hebrewMonth = 13;
1825 } else {
1826 # Subtract the days of Adar I
1827 $hebrewDay -= $days;
1828 # Try Adar II
1829 $days = 29;
1830 if ( $hebrewDay <= $days ) {
1831 # Day in Adar II
1832 $hebrewMonth = 14;
1835 } elseif ( $hebrewMonth == 2 && $yearPattern == 2 ) {
1836 # Cheshvan in a complete year (otherwise as the rule below)
1837 $days = 30;
1838 } elseif ( $hebrewMonth == 3 && $yearPattern == 0 ) {
1839 # Kislev in an incomplete year (otherwise as the rule below)
1840 $days = 29;
1841 } else {
1842 # Odd months have 30 days, even have 29
1843 $days = 30 - ( $hebrewMonth - 1 ) % 2;
1845 if ( $hebrewDay <= $days ) {
1846 # In the current month
1847 break;
1848 } else {
1849 # Subtract the days of the current month
1850 $hebrewDay -= $days;
1851 # Try in the next month
1852 $hebrewMonth++;
1856 return [ $hebrewYear, $hebrewMonth, $hebrewDay, $days ];
1860 * This calculates the Hebrew year start, as days since 1 September.
1861 * Based on Carl Friedrich Gauss algorithm for finding Easter date.
1862 * Used for Hebrew date.
1864 * @param int $year
1866 * @return string
1868 private static function hebrewYearStart( $year ) {
1869 $a = ( 12 * ( $year - 1 ) + 17 ) % 19;
1870 $b = ( $year - 1 ) % 4;
1871 $m = 32.044093161144 + 1.5542417966212 * $a + $b / 4.0 - 0.0031777940220923 * ( $year - 1 );
1872 if ( $m < 0 ) {
1873 $m--;
1875 $Mar = intval( $m );
1876 if ( $m < 0 ) {
1877 $m++;
1879 $m -= $Mar;
1881 $c = ( $Mar + 3 * ( $year - 1 ) + 5 * $b + 5 ) % 7;
1882 if ( $c == 0 && $a > 11 && $m >= 0.89772376543210 ) {
1883 $Mar++;
1884 } elseif ( $c == 1 && $a > 6 && $m >= 0.63287037037037 ) {
1885 $Mar += 2;
1886 } elseif ( $c == 2 || $c == 4 || $c == 6 ) {
1887 $Mar++;
1890 $Mar += intval( ( $year - 3761 ) / 100 ) - intval( ( $year - 3761 ) / 400 ) - 24;
1891 return $Mar;
1895 * Algorithm to convert Gregorian dates to Thai solar dates,
1896 * Minguo dates or Minguo dates.
1898 * Link: https://en.wikipedia.org/wiki/Thai_solar_calendar
1899 * https://en.wikipedia.org/wiki/Minguo_calendar
1900 * https://en.wikipedia.org/wiki/Japanese_era_name
1902 * @param string $ts 14-character timestamp
1903 * @param string $cName Calender name
1904 * @return array Converted year, month, day
1906 private static function tsToYear( $ts, $cName ) {
1907 $gy = substr( $ts, 0, 4 );
1908 $gm = substr( $ts, 4, 2 );
1909 $gd = substr( $ts, 6, 2 );
1911 if ( !strcmp( $cName, 'thai' ) ) {
1912 # Thai solar dates
1913 # Add 543 years to the Gregorian calendar
1914 # Months and days are identical
1915 $gy_offset = $gy + 543;
1916 # fix for dates between 1912 and 1941
1917 # https://en.wikipedia.org/?oldid=836596673#New_year
1918 if ( $gy >= 1912 && $gy <= 1940 ) {
1919 if ( $gm <= 3 ) {
1920 $gy_offset--;
1922 $gm = ( $gm - 3 ) % 12;
1924 } elseif ( ( !strcmp( $cName, 'minguo' ) ) || !strcmp( $cName, 'juche' ) ) {
1925 # Minguo dates
1926 # Deduct 1911 years from the Gregorian calendar
1927 # Months and days are identical
1928 $gy_offset = $gy - 1911;
1929 } elseif ( !strcmp( $cName, 'tenno' ) ) {
1930 # Nengō dates up to Meiji period
1931 # Deduct years from the Gregorian calendar
1932 # depending on the nengo periods
1933 # Months and days are identical
1934 if ( ( $gy < 1912 )
1935 || ( ( $gy == 1912 ) && ( $gm < 7 ) )
1936 || ( ( $gy == 1912 ) && ( $gm == 7 ) && ( $gd < 31 ) )
1938 # Meiji period
1939 $gy_gannen = $gy - 1868 + 1;
1940 $gy_offset = $gy_gannen;
1941 if ( $gy_gannen == 1 ) {
1942 $gy_offset = '元';
1944 $gy_offset = '明治' . $gy_offset;
1945 } elseif (
1946 ( ( $gy == 1912 ) && ( $gm == 7 ) && ( $gd == 31 ) ) ||
1947 ( ( $gy == 1912 ) && ( $gm >= 8 ) ) ||
1948 ( ( $gy > 1912 ) && ( $gy < 1926 ) ) ||
1949 ( ( $gy == 1926 ) && ( $gm < 12 ) ) ||
1950 ( ( $gy == 1926 ) && ( $gm == 12 ) && ( $gd < 26 ) )
1952 # Taishō period
1953 $gy_gannen = $gy - 1912 + 1;
1954 $gy_offset = $gy_gannen;
1955 if ( $gy_gannen == 1 ) {
1956 $gy_offset = '元';
1958 $gy_offset = '大正' . $gy_offset;
1959 } elseif (
1960 ( ( $gy == 1926 ) && ( $gm == 12 ) && ( $gd >= 26 ) ) ||
1961 ( ( $gy > 1926 ) && ( $gy < 1989 ) ) ||
1962 ( ( $gy == 1989 ) && ( $gm == 1 ) && ( $gd < 8 ) )
1964 # Shōwa period
1965 $gy_gannen = $gy - 1926 + 1;
1966 $gy_offset = $gy_gannen;
1967 if ( $gy_gannen == 1 ) {
1968 $gy_offset = '元';
1970 $gy_offset = '昭和' . $gy_offset;
1971 } elseif (
1972 ( ( $gy == 1989 ) && ( $gm == 1 ) && ( $gd >= 8 ) ) ||
1973 ( ( $gy > 1989 ) && ( $gy < 2019 ) ) ||
1974 ( ( $gy == 2019 ) && ( $gm < 5 ) )
1976 # Heisei period
1977 $gy_gannen = $gy - 1989 + 1;
1978 $gy_offset = $gy_gannen;
1979 if ( $gy_gannen == 1 ) {
1980 $gy_offset = '元';
1982 $gy_offset = '平成' . $gy_offset;
1983 } else {
1984 # Reiwa period
1985 $gy_gannen = $gy - 2019 + 1;
1986 $gy_offset = $gy_gannen;
1987 if ( $gy_gannen == 1 ) {
1988 $gy_offset = '元';
1990 $gy_offset = '令和' . $gy_offset;
1992 } else {
1993 $gy_offset = $gy;
1996 return [ $gy_offset, $gm, $gd ];
2000 * Gets directionality of the first strongly directional codepoint, for embedBidi()
2002 * This is the rule the BIDI algorithm uses to determine the directionality of
2003 * paragraphs ( https://www.unicode.org/reports/tr9/#The_Paragraph_Level ) and
2004 * FSI isolates ( https://www.unicode.org/reports/tr9/#Explicit_Directional_Isolates ).
2006 * TODO: Does not handle BIDI control characters inside the text.
2007 * TODO: Does not handle unallocated characters.
2009 * @param string $text Text to test
2010 * @return null|string Directionality ('ltr' or 'rtl') or null
2012 private static function strongDirFromContent( $text = '' ) {
2013 if ( !preg_match( self::$strongDirRegex, $text, $matches ) ) {
2014 return null;
2016 if ( $matches[1] === '' ) {
2017 return 'rtl';
2019 return 'ltr';
2023 * Roman number formatting up to 10000
2025 * @param int $num
2027 * @return string
2029 public static function romanNumeral( $num ) {
2030 static $table = [
2031 [ '', 'I', 'II', 'III', 'IV', 'V', 'VI', 'VII', 'VIII', 'IX', 'X' ],
2032 [ '', 'X', 'XX', 'XXX', 'XL', 'L', 'LX', 'LXX', 'LXXX', 'XC', 'C' ],
2033 [ '', 'C', 'CC', 'CCC', 'CD', 'D', 'DC', 'DCC', 'DCCC', 'CM', 'M' ],
2034 [ '', 'M', 'MM', 'MMM', 'MMMM', 'MMMMM', 'MMMMMM', 'MMMMMMM',
2035 'MMMMMMMM', 'MMMMMMMMM', 'MMMMMMMMMM' ]
2038 $num = intval( $num );
2039 if ( $num > 10000 || $num <= 0 ) {
2040 return $num;
2043 $s = '';
2044 for ( $pow10 = 1000, $i = 3; $i >= 0; $pow10 /= 10, $i-- ) {
2045 if ( $num >= $pow10 ) {
2046 $s .= $table[$i][(int)floor( $num / $pow10 )];
2048 $num %= $pow10;
2050 return $s;
2054 * Hebrew Gematria number formatting up to 9999
2056 * @param int $num
2058 * @return string
2060 public static function hebrewNumeral( $num ) {
2061 static $table = [
2062 [ '', 'א', 'ב', 'ג', 'ד', 'ה', 'ו', 'ז', 'ח', 'ט', 'י' ],
2063 [ '', 'י', 'כ', 'ל', 'מ', 'נ', 'ס', 'ע', 'פ', 'צ', 'ק' ],
2064 [ '',
2065 [ 'ק' ],
2066 [ 'ר' ],
2067 [ 'ש' ],
2068 [ 'ת' ],
2069 [ 'ת', 'ק' ],
2070 [ 'ת', 'ר' ],
2071 [ 'ת', 'ש' ],
2072 [ 'ת', 'ת' ],
2073 [ 'ת', 'ת', 'ק' ],
2074 [ 'ת', 'ת', 'ר' ],
2076 [ '', 'א', 'ב', 'ג', 'ד', 'ה', 'ו', 'ז', 'ח', 'ט', 'י' ]
2079 $num = intval( $num );
2080 if ( $num > 9999 || $num <= 0 ) {
2081 return $num;
2084 // Round thousands have special notations
2085 if ( $num === 1000 ) {
2086 return "א' אלף";
2087 } elseif ( $num % 1000 === 0 ) {
2088 return $table[0][$num / 1000] . "' אלפים";
2091 $letters = [];
2093 for ( $pow10 = 1000, $i = 3; $i >= 0; $pow10 /= 10, $i-- ) {
2094 if ( $num >= $pow10 ) {
2095 if ( $num === 15 || $num === 16 ) {
2096 $letters[] = $table[0][9];
2097 $letters[] = $table[0][$num - 9];
2098 $num = 0;
2099 } else {
2100 $letters = array_merge(
2101 $letters,
2102 (array)$table[$i][intval( $num / $pow10 )]
2105 if ( $pow10 === 1000 ) {
2106 $letters[] = "'";
2111 $num %= $pow10;
2114 $preTransformLength = count( $letters );
2115 if ( $preTransformLength === 1 ) {
2116 // Add geresh (single quote) to one-letter numbers
2117 $letters[] = "'";
2118 } else {
2119 $lastIndex = $preTransformLength - 1;
2120 $letters[$lastIndex] = str_replace(
2121 [ 'כ', 'מ', 'נ', 'פ', 'צ' ],
2122 [ 'ך', 'ם', 'ן', 'ף', 'ץ' ],
2123 $letters[$lastIndex]
2126 // Add gershayim (double quote) to multiple-letter numbers,
2127 // but exclude numbers with only one letter after the thousands
2128 // (1001-1009, 1020, 1030, 2001-2009, etc.)
2129 if ( $letters[1] === "'" && $preTransformLength === 3 ) {
2130 $letters[] = "'";
2131 } else {
2132 array_splice( $letters, -1, 0, '"' );
2136 return implode( $letters );
2140 * Used by date() and time() to adjust the time output.
2142 * @param string $ts The time in date('YmdHis') format
2143 * @param mixed $tz Adjust the time by this amount (default false, mean we
2144 * get user timecorrection setting)
2145 * @return int
2147 public function userAdjust( $ts, $tz = false ) {
2148 global $wgLocalTZoffset;
2150 if ( $tz === false ) {
2151 $optionsLookup = MediaWikiServices::getInstance()->getUserOptionsLookup();
2152 $tz = $optionsLookup->getOption(
2153 RequestContext::getMain()->getUser(),
2154 'timecorrection'
2158 $data = explode( '|', $tz, 3 );
2160 if ( $data[0] == 'ZoneInfo' ) {
2161 try {
2162 $userTZ = new DateTimeZone( $data[2] );
2163 $date = new DateTime( $ts, new DateTimeZone( 'UTC' ) );
2164 $date->setTimezone( $userTZ );
2165 return $date->format( 'YmdHis' );
2166 } catch ( Exception $e ) {
2167 // Unrecognized timezone, default to 'Offset' with the stored offset.
2168 $data[0] = 'Offset';
2172 // @phan-suppress-next-line PhanSuspiciousValueComparison
2173 if ( $data[0] == 'System' || $tz == '' ) {
2174 # Global offset in minutes.
2175 $minDiff = $wgLocalTZoffset;
2176 } elseif ( $data[0] == 'Offset' ) {
2177 $minDiff = intval( $data[1] );
2178 } else {
2179 $data = explode( ':', $tz );
2180 if ( count( $data ) == 2 ) {
2181 $data[0] = intval( $data[0] );
2182 $data[1] = intval( $data[1] );
2183 $minDiff = abs( $data[0] ) * 60 + $data[1];
2184 if ( $data[0] < 0 ) {
2185 $minDiff = -$minDiff;
2187 } else {
2188 $minDiff = intval( $data[0] ) * 60;
2192 # No difference ? Return time unchanged
2193 if ( $minDiff == 0 ) {
2194 return $ts;
2197 Wikimedia\suppressWarnings(); // E_STRICT system time bitching
2198 # Generate an adjusted date; take advantage of the fact that mktime
2199 # will normalize out-of-range values so we don't have to split $minDiff
2200 # into hours and minutes.
2201 $t = mktime( (
2202 (int)substr( $ts, 8, 2 ) ), # Hours
2203 (int)substr( $ts, 10, 2 ) + $minDiff, # Minutes
2204 (int)substr( $ts, 12, 2 ), # Seconds
2205 (int)substr( $ts, 4, 2 ), # Month
2206 (int)substr( $ts, 6, 2 ), # Day
2207 (int)substr( $ts, 0, 4 ) ); # Year
2209 $date = date( 'YmdHis', $t );
2210 Wikimedia\restoreWarnings();
2212 return $date;
2216 * This is meant to be used by time(), date(), and timeanddate() to get
2217 * the date preference they're supposed to use, it should be used in
2218 * all children.
2220 * function timeanddate([...], $format = true) {
2221 * $datePreference = $this->dateFormat($format);
2222 * [...]
2225 * @param int|string|bool $usePrefs If true, the user's preference is used
2226 * if false, the site/language default is used
2227 * if int/string, assumed to be a format.
2228 * @return string
2230 public function dateFormat( $usePrefs = true ) {
2231 if ( is_bool( $usePrefs ) ) {
2232 if ( $usePrefs ) {
2233 $datePreference = RequestContext::getMain()
2234 ->getUser()
2235 ->getDatePreference();
2236 } else {
2237 $datePreference = (string)User::getDefaultOption( 'date' );
2239 } else {
2240 $datePreference = (string)$usePrefs;
2243 // return int
2244 if ( $datePreference == '' ) {
2245 return 'default';
2248 return $datePreference;
2252 * Get a format string for a given type and preference
2253 * @param string $type May be 'date', 'time', 'both', or 'pretty'.
2254 * @param string $pref The format name as it appears in Messages*.php under
2255 * $datePreferences.
2257 * @since 1.22 New type 'pretty' that provides a more readable timestamp format
2259 * @return string
2261 public function getDateFormatString( $type, $pref ) {
2262 $wasDefault = false;
2263 if ( $pref == 'default' ) {
2264 $wasDefault = true;
2265 $pref = $this->getDefaultDateFormat();
2268 if ( !isset( $this->dateFormatStrings[$type][$pref] ) ) {
2269 $df = $this->localisationCache
2270 ->getSubitem( $this->mCode, 'dateFormats', "$pref $type" );
2272 if ( $type === 'pretty' && $df === null ) {
2273 $df = $this->getDateFormatString( 'date', $pref );
2276 if ( !$wasDefault && $df === null ) {
2277 $pref = $this->getDefaultDateFormat();
2278 $df = $this->localisationCache
2279 ->getSubitem( $this->mCode, 'dateFormats', "$pref $type" );
2282 $this->dateFormatStrings[$type][$pref] = $df;
2284 return $this->dateFormatStrings[$type][$pref];
2288 * @param string $ts The time format which needs to be turned into a
2289 * date('YmdHis') format with wfTimestamp(TS_MW,$ts)
2290 * @param bool $adj Whether to adjust the time output according to the
2291 * user configured offset ($timecorrection)
2292 * @param mixed $format True to use user's date format preference
2293 * @param string|bool $timecorrection The time offset as returned by
2294 * validateTimeZone() in Special:Preferences
2295 * @return string
2297 public function date( $ts, $adj = false, $format = true, $timecorrection = false ) {
2298 $ts = wfTimestamp( TS_MW, $ts );
2299 if ( $adj ) {
2300 $ts = $this->userAdjust( $ts, $timecorrection );
2302 $df = $this->getDateFormatString( 'date', $this->dateFormat( $format ) );
2303 return $this->sprintfDate( $df, $ts );
2307 * @param string $ts The time format which needs to be turned into a
2308 * date('YmdHis') format with wfTimestamp(TS_MW,$ts)
2309 * @param bool $adj Whether to adjust the time output according to the
2310 * user configured offset ($timecorrection)
2311 * @param mixed $format True to use user's date format preference
2312 * @param string|bool $timecorrection The time offset as returned by
2313 * validateTimeZone() in Special:Preferences
2314 * @return string
2316 public function time( $ts, $adj = false, $format = true, $timecorrection = false ) {
2317 $ts = wfTimestamp( TS_MW, $ts );
2318 if ( $adj ) {
2319 $ts = $this->userAdjust( $ts, $timecorrection );
2321 $df = $this->getDateFormatString( 'time', $this->dateFormat( $format ) );
2322 return $this->sprintfDate( $df, $ts );
2326 * @param string $ts The time format which needs to be turned into a
2327 * date('YmdHis') format with wfTimestamp(TS_MW,$ts)
2328 * @param bool $adj Whether to adjust the time output according to the
2329 * user configured offset ($timecorrection)
2330 * @param mixed $format What format to return, if it's false output the
2331 * default one (default true)
2332 * @param string|bool $timecorrection The time offset as returned by
2333 * validateTimeZone() in Special:Preferences
2334 * @return string
2336 public function timeanddate( $ts, $adj = false, $format = true, $timecorrection = false ) {
2337 $ts = wfTimestamp( TS_MW, $ts );
2338 if ( $adj ) {
2339 $ts = $this->userAdjust( $ts, $timecorrection );
2341 $df = $this->getDateFormatString( 'both', $this->dateFormat( $format ) );
2342 return $this->sprintfDate( $df, $ts );
2346 * Takes a number of seconds and turns it into a text using values such as hours and minutes.
2348 * @since 1.20
2350 * @param int $seconds The amount of seconds.
2351 * @param array $chosenIntervals The intervals to enable.
2353 * @return string
2355 public function formatDuration( $seconds, array $chosenIntervals = [] ) {
2356 $intervals = $this->getDurationIntervals( $seconds, $chosenIntervals );
2358 $segments = [];
2360 foreach ( $intervals as $intervalName => $intervalValue ) {
2361 // Messages: duration-seconds, duration-minutes, duration-hours, duration-days, duration-weeks,
2362 // duration-years, duration-decades, duration-centuries, duration-millennia
2363 $message = wfMessage( 'duration-' . $intervalName )->numParams( $intervalValue );
2364 $segments[] = $message->inLanguage( $this )->escaped();
2367 return $this->listToText( $segments );
2371 * Takes a number of seconds and returns an array with a set of corresponding intervals.
2372 * For example 65 will be turned into [ minutes => 1, seconds => 5 ].
2374 * @since 1.20
2376 * @param int $seconds The amount of seconds.
2377 * @param array $chosenIntervals The intervals to enable.
2379 * @return array
2381 public function getDurationIntervals( $seconds, array $chosenIntervals = [] ) {
2382 if ( empty( $chosenIntervals ) ) {
2383 $chosenIntervals = [
2384 'millennia',
2385 'centuries',
2386 'decades',
2387 'years',
2388 'days',
2389 'hours',
2390 'minutes',
2391 'seconds'
2395 $intervals = array_intersect_key( self::DURATION_INTERVALS, array_flip( $chosenIntervals ) );
2396 $sortedNames = array_keys( $intervals );
2397 $smallestInterval = array_pop( $sortedNames );
2399 $segments = [];
2401 foreach ( $intervals as $name => $length ) {
2402 $value = floor( $seconds / $length );
2404 if ( $value > 0 || ( $name == $smallestInterval && empty( $segments ) ) ) {
2405 $seconds -= $value * $length;
2406 $segments[$name] = $value;
2410 return $segments;
2414 * Internal helper function for userDate(), userTime() and userTimeAndDate()
2416 * @param string $type Can be 'date', 'time' or 'both'
2417 * @param string $ts The time format which needs to be turned into a
2418 * date('YmdHis') format with wfTimestamp(TS_MW,$ts)
2419 * @param User $user User object used to get preferences for timezone and format
2420 * @param array $options Array, can contain the following keys:
2421 * - 'timecorrection': time correction, can have the following values:
2422 * - true: use user's preference
2423 * - false: don't use time correction
2424 * - int: value of time correction in minutes
2425 * - 'format': format to use, can have the following values:
2426 * - true: use user's preference
2427 * - false: use default preference
2428 * - string: format to use
2429 * @since 1.19
2430 * @return string
2432 private function internalUserTimeAndDate( $type, $ts, User $user, array $options ) {
2433 $ts = wfTimestamp( TS_MW, $ts );
2434 $options += [ 'timecorrection' => true, 'format' => true ];
2435 if ( $options['timecorrection'] !== false ) {
2436 if ( $options['timecorrection'] === true ) {
2437 $offset = $user->getOption( 'timecorrection' );
2438 } else {
2439 $offset = $options['timecorrection'];
2441 $ts = $this->userAdjust( $ts, $offset );
2443 if ( $options['format'] === true ) {
2444 $format = $user->getDatePreference();
2445 } else {
2446 $format = $options['format'];
2448 $df = $this->getDateFormatString( $type, $this->dateFormat( $format ) );
2449 return $this->sprintfDate( $df, $ts );
2453 * Get the formatted date for the given timestamp and formatted for
2454 * the given user.
2456 * @param mixed $ts Mixed: the time format which needs to be turned into a
2457 * date('YmdHis') format with wfTimestamp(TS_MW,$ts)
2458 * @param User $user User object used to get preferences for timezone and format
2459 * @param array $options Array, can contain the following keys:
2460 * - 'timecorrection': time correction, can have the following values:
2461 * - true: use user's preference
2462 * - false: don't use time correction
2463 * - int: value of time correction in minutes
2464 * - 'format': format to use, can have the following values:
2465 * - true: use user's preference
2466 * - false: use default preference
2467 * - string: format to use
2468 * @since 1.19
2469 * @return string
2471 public function userDate( $ts, User $user, array $options = [] ) {
2472 return $this->internalUserTimeAndDate( 'date', $ts, $user, $options );
2476 * Get the formatted time for the given timestamp and formatted for
2477 * the given user.
2479 * @param mixed $ts The time format which needs to be turned into a
2480 * date('YmdHis') format with wfTimestamp(TS_MW,$ts)
2481 * @param User $user User object used to get preferences for timezone and format
2482 * @param array $options Array, can contain the following keys:
2483 * - 'timecorrection': time correction, can have the following values:
2484 * - true: use user's preference
2485 * - false: don't use time correction
2486 * - int: value of time correction in minutes
2487 * - 'format': format to use, can have the following values:
2488 * - true: use user's preference
2489 * - false: use default preference
2490 * - string: format to use
2491 * @since 1.19
2492 * @return string
2494 public function userTime( $ts, User $user, array $options = [] ) {
2495 return $this->internalUserTimeAndDate( 'time', $ts, $user, $options );
2499 * Get the formatted date and time for the given timestamp and formatted for
2500 * the given user.
2502 * @param mixed $ts The time format which needs to be turned into a
2503 * date('YmdHis') format with wfTimestamp(TS_MW,$ts)
2504 * @param User $user User object used to get preferences for timezone and format
2505 * @param array $options Array, can contain the following keys:
2506 * - 'timecorrection': time correction, can have the following values:
2507 * - true: use user's preference
2508 * - false: don't use time correction
2509 * - int: value of time correction in minutes
2510 * - 'format': format to use, can have the following values:
2511 * - true: use user's preference
2512 * - false: use default preference
2513 * - string: format to use
2514 * @since 1.19
2515 * @return string
2517 public function userTimeAndDate( $ts, User $user, array $options = [] ) {
2518 return $this->internalUserTimeAndDate( 'both', $ts, $user, $options );
2522 * Get the timestamp in a human-friendly relative format, e.g., "3 days ago".
2524 * Determine the difference between the timestamp and the current time, and
2525 * generate a readable timestamp by returning "<N> <units> ago", where the
2526 * largest possible unit is used.
2528 * @since 1.26 (Prior to 1.26 method existed but was not meant to be used directly)
2530 * @param MWTimestamp $time
2531 * @param MWTimestamp|null $relativeTo The base timestamp to compare to (defaults to now)
2532 * @param User|null $user User the timestamp is being generated for
2533 * (or null to use main context's user)
2534 * @return string Formatted timestamp
2536 public function getHumanTimestamp(
2537 MWTimestamp $time, MWTimestamp $relativeTo = null, User $user = null
2539 if ( $relativeTo === null ) {
2540 $relativeTo = new MWTimestamp();
2542 if ( $user === null ) {
2543 $user = RequestContext::getMain()->getUser();
2546 // Adjust for the user's timezone.
2547 $offsetThis = $time->offsetForUser( $user );
2548 $offsetRel = $relativeTo->offsetForUser( $user );
2550 $ts = '';
2551 if ( $this->getHookRunner()->onGetHumanTimestamp( $ts, $time, $relativeTo, $user, $this ) ) {
2552 $ts = $this->getHumanTimestampInternal( $time, $relativeTo, $user );
2555 // Reset the timezone on the objects.
2556 $time->timestamp->sub( $offsetThis );
2557 $relativeTo->timestamp->sub( $offsetRel );
2559 return $ts;
2563 * Convert an MWTimestamp into a pretty human-readable timestamp using
2564 * the given user preferences and relative base time.
2566 * @see Language::getHumanTimestamp
2567 * @param MWTimestamp $ts Timestamp to prettify
2568 * @param MWTimestamp $relativeTo Base timestamp
2569 * @param User $user User preferences to use
2570 * @return string Human timestamp
2571 * @since 1.26
2573 private function getHumanTimestampInternal(
2574 MWTimestamp $ts, MWTimestamp $relativeTo, User $user
2576 $diff = $ts->diff( $relativeTo );
2577 $diffDay = (bool)( (int)$ts->timestamp->format( 'w' ) -
2578 (int)$relativeTo->timestamp->format( 'w' ) );
2579 $days = $diff->days ?: (int)$diffDay;
2580 if ( $diff->invert || $days > 5
2581 && $ts->timestamp->format( 'Y' ) !== $relativeTo->timestamp->format( 'Y' )
2583 // Timestamps are in different years: use full timestamp
2584 // Also do full timestamp for future dates
2586 * @todo FIXME: Add better handling of future timestamps.
2588 $format = $this->getDateFormatString( 'both', $user->getDatePreference() ?: 'default' );
2589 $ts = $this->sprintfDate( $format, $ts->getTimestamp( TS_MW ) );
2590 } elseif ( $days > 5 ) {
2591 // Timestamps are in same year, but more than 5 days ago: show day and month only.
2592 $format = $this->getDateFormatString( 'pretty', $user->getDatePreference() ?: 'default' );
2593 $ts = $this->sprintfDate( $format, $ts->getTimestamp( TS_MW ) );
2594 } elseif ( $days > 1 ) {
2595 // Timestamp within the past week: show the day of the week and time
2596 $format = $this->getDateFormatString( 'time', $user->getDatePreference() ?: 'default' );
2597 $weekday = self::WEEKDAY_MESSAGES[$ts->timestamp->format( 'w' )];
2598 // Messages:
2599 // sunday-at, monday-at, tuesday-at, wednesday-at, thursday-at, friday-at, saturday-at
2600 $ts = wfMessage( "$weekday-at" )
2601 ->inLanguage( $this )
2602 ->params( $this->sprintfDate( $format, $ts->getTimestamp( TS_MW ) ) )
2603 ->text();
2604 } elseif ( $days == 1 ) {
2605 // Timestamp was yesterday: say 'yesterday' and the time.
2606 $format = $this->getDateFormatString( 'time', $user->getDatePreference() ?: 'default' );
2607 $ts = wfMessage( 'yesterday-at' )
2608 ->inLanguage( $this )
2609 ->params( $this->sprintfDate( $format, $ts->getTimestamp( TS_MW ) ) )
2610 ->text();
2611 } elseif ( $diff->h > 1 || $diff->h == 1 && $diff->i > 30 ) {
2612 // Timestamp was today, but more than 90 minutes ago: say 'today' and the time.
2613 $format = $this->getDateFormatString( 'time', $user->getDatePreference() ?: 'default' );
2614 $ts = wfMessage( 'today-at' )
2615 ->inLanguage( $this )
2616 ->params( $this->sprintfDate( $format, $ts->getTimestamp( TS_MW ) ) )
2617 ->text();
2619 // From here on in, the timestamp was soon enough ago so that we can simply say
2620 // XX units ago, e.g., "2 hours ago" or "5 minutes ago"
2621 } elseif ( $diff->h == 1 ) {
2622 // Less than 90 minutes, but more than an hour ago.
2623 $ts = wfMessage( 'hours-ago' )->inLanguage( $this )->numParams( 1 )->text();
2624 } elseif ( $diff->i >= 1 ) {
2625 // A few minutes ago.
2626 $ts = wfMessage( 'minutes-ago' )->inLanguage( $this )->numParams( $diff->i )->text();
2627 } elseif ( $diff->s >= 30 ) {
2628 // Less than a minute, but more than 30 sec ago.
2629 $ts = wfMessage( 'seconds-ago' )->inLanguage( $this )->numParams( $diff->s )->text();
2630 } else {
2631 // Less than 30 seconds ago.
2632 $ts = wfMessage( 'just-now' )->text();
2635 return $ts;
2639 * @param string $key
2640 * @return string|null
2642 public function getMessage( $key ) {
2643 return $this->localisationCache->getSubitem( $this->mCode, 'messages', $key );
2647 * @return array
2649 public function getAllMessages() {
2650 return $this->localisationCache->getItem( $this->mCode, 'messages' );
2654 * @param string $in
2655 * @param string $out
2656 * @param string $string
2657 * @return string
2659 public function iconv( $in, $out, $string ) {
2660 # Even with //IGNORE iconv can whine about illegal characters in
2661 # *input* string. We just ignore those too.
2662 # REF: https://bugs.php.net/bug.php?id=37166
2663 # REF: https://phabricator.wikimedia.org/T18885
2664 Wikimedia\suppressWarnings();
2665 $text = iconv( $in, $out . '//IGNORE', $string );
2666 Wikimedia\restoreWarnings();
2667 return $text;
2671 * @param string $str
2672 * @return string The string with uppercase conversion applied to the first character
2674 public function ucfirst( $str ) {
2675 $octetCode = ord( $str );
2676 // See https://en.wikipedia.org/wiki/ASCII#Printable_characters
2677 if ( $octetCode < 96 ) {
2678 // Assume this is an uppercase/uncased ASCII character
2679 return (string)$str;
2680 } elseif ( $octetCode < 128 ) {
2681 // Assume this is a lowercase/uncased ASCII character
2682 return ucfirst( $str );
2685 $first = mb_substr( $str, 0, 1 );
2686 return ( strlen( $first ) !== 1 )
2687 // Assume this is a multibyte character and mb_internal_encoding() is appropriate
2688 ? $this->mbUpperChar( $first ) . mb_substr( $str, 1 )
2689 // Assume this is a non-multibyte character and LC_CASE is appropriate
2690 : ucfirst( $str );
2694 * @param string $str
2695 * @param bool $first Whether to uppercase only the first character
2696 * @return string The string with uppercase conversion applied
2698 public function uc( $str, $first = false ) {
2699 if ( $first ) {
2700 return $this->ucfirst( $str );
2701 } else {
2702 return $this->isMultibyte( $str ) ? mb_strtoupper( $str ) : strtoupper( $str );
2707 * Convert character to uppercase, allowing overrides of the default mb_upper
2708 * behaviour, which is buggy in many ways. Having a conversion table can be
2709 * useful during transitions between PHP versions where unicode changes happen.
2710 * This can make some resources unreachable on-wiki, see discussion at T219279.
2711 * Providing such a conversion table can allow to manage the transition period.
2713 * @since 1.34
2715 * @param string $char
2717 * @return string
2719 protected function mbUpperChar( $char ) {
2720 global $wgOverrideUcfirstCharacters;
2722 return $wgOverrideUcfirstCharacters[$char] ?? mb_strtoupper( $char );
2726 * @param string $str
2727 * @return string The string with lowercase conversion applied to the first character
2729 public function lcfirst( $str ) {
2730 $octetCode = ord( $str );
2731 // See https://en.wikipedia.org/wiki/ASCII#Printable_characters
2732 if ( $octetCode < 96 ) {
2733 // Assume this is an uppercase/uncased ASCII character
2734 return lcfirst( $str );
2735 } elseif ( $octetCode < 128 ) {
2736 // Assume this is a lowercase/uncased ASCII character
2737 return (string)$str;
2740 return $this->isMultibyte( $str )
2741 // Assume this is a multibyte character and mb_internal_encoding() is appropriate
2742 ? mb_strtolower( mb_substr( $str, 0, 1 ) ) . mb_substr( $str, 1 )
2743 // Assume this is a non-multibyte character and LC_CASE is appropriate
2744 : lcfirst( $str );
2748 * @param string $str
2749 * @param bool $first Whether to lowercase only the first character
2750 * @return string The string with lowercase conversion applied
2752 public function lc( $str, $first = false ) {
2753 if ( $first ) {
2754 return $this->lcfirst( $str );
2755 } else {
2756 return $this->isMultibyte( $str ) ? mb_strtolower( $str ) : strtolower( $str );
2761 * @param string $str
2762 * @return bool
2764 private function isMultibyte( $str ) {
2765 return strlen( $str ) !== mb_strlen( $str );
2769 * @param string $str
2770 * @return mixed|string
2772 public function ucwords( $str ) {
2773 if ( $this->isMultibyte( $str ) ) {
2774 $str = $this->lc( $str );
2776 // regexp to find first letter in each word (i.e. after each space)
2777 $replaceRegexp = "/^([a-z]|[\\xc0-\\xff][\\x80-\\xbf]*)| ([a-z]|[\\xc0-\\xff][\\x80-\\xbf]*)/";
2779 // function to use to capitalize a single char
2780 return preg_replace_callback(
2781 $replaceRegexp,
2782 static function ( $matches ) {
2783 return mb_strtoupper( $matches[0] );
2785 $str
2787 } else {
2788 return ucwords( strtolower( $str ) );
2793 * capitalize words at word breaks
2795 * @param string $str
2796 * @return mixed
2798 public function ucwordbreaks( $str ) {
2799 if ( $this->isMultibyte( $str ) ) {
2800 $str = $this->lc( $str );
2802 // since \b doesn't work for UTF-8, we explicitely define word break chars
2803 $breaks = "[ \-\(\)\}\{\.,\?!]";
2805 // find first letter after word break
2806 $replaceRegexp = "/^([a-z]|[\\xc0-\\xff][\\x80-\\xbf]*)|" .
2807 "$breaks([a-z]|[\\xc0-\\xff][\\x80-\\xbf]*)/";
2809 return preg_replace_callback(
2810 $replaceRegexp,
2811 static function ( $matches ) {
2812 return mb_strtoupper( $matches[0] );
2814 $str
2816 } else {
2817 return preg_replace_callback(
2818 '/\b([\w\x80-\xff]+)\b/',
2819 function ( $matches ) {
2820 return $this->ucfirst( $matches[1] );
2822 $str
2828 * Return a case-folded representation of $s
2830 * This is a representation such that caseFold($s1)==caseFold($s2) if $s1
2831 * and $s2 are the same except for the case of their characters. It is not
2832 * necessary for the value returned to make sense when displayed.
2834 * Do *not* perform any other normalisation in this function. If a caller
2835 * uses this function when it should be using a more general normalisation
2836 * function, then fix the caller.
2838 * @param string $s
2840 * @return string
2842 public function caseFold( $s ) {
2843 return $this->uc( $s );
2847 * TODO: $s is not always a string per T218883
2848 * @param string $s
2849 * @return string
2851 public function checkTitleEncoding( $s ) {
2852 if ( is_array( $s ) ) {
2853 throw new MWException( 'Given array to checkTitleEncoding.' );
2855 if ( StringUtils::isUtf8( $s ) ) {
2856 return $s;
2859 return $this->iconv( $this->fallback8bitEncoding(), 'utf-8', $s );
2863 * @return string
2865 public function fallback8bitEncoding() {
2866 return $this->localisationCache->getItem( $this->mCode, 'fallback8bitEncoding' );
2870 * Most writing systems use whitespace to break up words.
2871 * Some languages such as Chinese don't conventionally do this,
2872 * which requires special handling when breaking up words for
2873 * searching etc.
2875 * @return bool
2877 public function hasWordBreaks() {
2878 return true;
2882 * Some languages such as Chinese require word segmentation,
2883 * Specify such segmentation when overridden in derived class.
2885 * @param string $string
2886 * @return string
2888 public function segmentByWord( $string ) {
2889 return $string;
2893 * Some languages have special punctuation need to be normalized.
2894 * Make such changes here.
2896 * @param string $string
2897 * @return string
2899 public function normalizeForSearch( $string ) {
2900 return self::convertDoubleWidth( $string );
2904 * convert double-width roman characters to single-width.
2905 * range: ff00-ff5f ~= 0020-007f
2907 * @param string $string
2909 * @return string
2911 protected static function convertDoubleWidth( $string ) {
2912 static $full = null;
2913 static $half = null;
2915 if ( $full === null ) {
2916 $fullWidth = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
2917 $halfWidth = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
2918 $full = str_split( $fullWidth, 3 );
2919 $half = str_split( $halfWidth );
2922 $string = str_replace( $full, $half, $string );
2923 return $string;
2927 * @param string $string
2928 * @param string $pattern
2929 * @return string
2931 protected static function insertSpace( $string, $pattern ) {
2932 $string = preg_replace( $pattern, " $1 ", $string );
2933 $string = preg_replace( '/ +/', ' ', $string );
2934 return $string;
2938 * @param string[] $termsArray
2939 * @return string[]
2941 public function convertForSearchResult( $termsArray ) {
2942 # some languages, e.g. Chinese, need to do a conversion
2943 # in order for search results to be displayed correctly
2944 return $termsArray;
2948 * Get the first character of a string.
2950 * @param string $s
2951 * @return string
2953 public function firstChar( $s ) {
2954 $firstChar = mb_substr( $s, 0, 1 );
2956 if ( $firstChar !== false ) {
2957 if ( strlen( $firstChar ) != 3 ) {
2958 return $firstChar;
2961 // Break down Hangul syllables to grab the first jamo
2962 $code = mb_ord( $firstChar );
2963 if ( $code < 0xac00 || $code >= 0xd7a4 ) {
2964 return $firstChar;
2965 } elseif ( $code < 0xb098 ) {
2966 return "\u{3131}";
2967 } elseif ( $code < 0xb2e4 ) {
2968 return "\u{3134}";
2969 } elseif ( $code < 0xb77c ) {
2970 return "\u{3137}";
2971 } elseif ( $code < 0xb9c8 ) {
2972 return "\u{3139}";
2973 } elseif ( $code < 0xbc14 ) {
2974 return "\u{3141}";
2975 } elseif ( $code < 0xc0ac ) {
2976 return "\u{3142}";
2977 } elseif ( $code < 0xc544 ) {
2978 return "\u{3145}";
2979 } elseif ( $code < 0xc790 ) {
2980 return "\u{3147}";
2981 } elseif ( $code < 0xcc28 ) {
2982 return "\u{3148}";
2983 } elseif ( $code < 0xce74 ) {
2984 return "\u{314A}";
2985 } elseif ( $code < 0xd0c0 ) {
2986 return "\u{314B}";
2987 } elseif ( $code < 0xd30c ) {
2988 return "\u{314C}";
2989 } elseif ( $code < 0xd558 ) {
2990 return "\u{314D}";
2991 } else {
2992 return "\u{314E}";
2996 return '';
3000 * Convert a UTF-8 string to normal form C. In Malayalam and Arabic, this
3001 * also cleans up certain backwards-compatible sequences, converting them
3002 * to the modern Unicode equivalent.
3004 * This is language-specific for performance reasons only.
3006 * @param string $s
3008 * @return string
3010 public function normalize( $s ) {
3011 global $wgAllUnicodeFixes, $IP;
3013 $s = UtfNormal\Validator::cleanUp( $s );
3014 if ( $wgAllUnicodeFixes ) {
3015 $s = $this->transformUsingPairFile( 'normalize-ar.php', $s, $IP );
3016 $s = $this->transformUsingPairFile( 'normalize-ml.php', $s, $IP );
3019 return $s;
3023 * Transform a string using serialized data stored in the given file (which
3024 * must be in the serialized subdirectory of $IP). The file contains pairs
3025 * mapping source characters to destination characters.
3027 * The data is cached in process memory. This will go faster if you have the
3028 * FastStringSearch extension.
3030 * @param string $file
3031 * @param string $string
3032 * @param string|null $basePath
3034 * @throws MWException
3035 * @return string
3037 protected function transformUsingPairFile( $file, $string, $basePath = null ) {
3038 if ( isset( $this->transformData[$file] ) ) {
3039 wfDeprecated(
3040 'Modification of Language::$transformData is deprecated since MediaWiki 1.35',
3041 '1.35'
3043 return $this->transformData[$file]->replace( $string );
3046 if ( $basePath === null ) {
3047 wfDeprecated( __METHOD__ . ' without $basePath', '1.35' );
3048 global $IP;
3049 $basePath = $IP;
3052 if (
3053 $basePath === null
3054 || $basePath === ''
3055 || !file_exists( "{$basePath}/languages/data/{$file}" )
3057 return $string;
3060 if ( !isset( $this->transformData[$basePath][$file] ) ) {
3061 $data = require "{$basePath}/languages/data/{$file}";
3062 $this->transformData[$basePath][$file] = new ReplacementArray( $data );
3065 return $this->transformData[$basePath][$file]->replace( $string );
3069 * For right-to-left language support
3071 * @return bool
3073 public function isRTL() {
3074 return $this->localisationCache->getItem( $this->mCode, 'rtl' );
3078 * Return the correct HTML 'dir' attribute value for this language.
3079 * @return string
3081 public function getDir() {
3082 return $this->isRTL() ? 'rtl' : 'ltr';
3086 * Return 'left' or 'right' as appropriate alignment for line-start
3087 * for this language's text direction.
3089 * Should be equivalent to CSS3 'start' text-align value....
3091 * @return string
3093 public function alignStart() {
3094 return $this->isRTL() ? 'right' : 'left';
3098 * Return 'right' or 'left' as appropriate alignment for line-end
3099 * for this language's text direction.
3101 * Should be equivalent to CSS3 'end' text-align value....
3103 * @return string
3105 public function alignEnd() {
3106 return $this->isRTL() ? 'left' : 'right';
3110 * A hidden direction mark (LRM or RLM), depending on the language direction.
3111 * Unlike getDirMark(), this function returns the character as an HTML entity.
3112 * This function should be used when the output is guaranteed to be HTML,
3113 * because it makes the output HTML source code more readable. When
3114 * the output is plain text or can be escaped, getDirMark() should be used.
3116 * @param bool $opposite Get the direction mark opposite to your language
3117 * @return string
3118 * @since 1.20
3120 public function getDirMarkEntity( $opposite = false ) {
3121 if ( $opposite ) {
3122 return $this->isRTL() ? '&lrm;' : '&rlm;';
3124 return $this->isRTL() ? '&rlm;' : '&lrm;';
3128 * A hidden direction mark (LRM or RLM), depending on the language direction.
3129 * This function produces them as invisible Unicode characters and
3130 * the output may be hard to read and debug, so it should only be used
3131 * when the output is plain text or can be escaped. When the output is
3132 * HTML, use getDirMarkEntity() instead.
3134 * @param bool $opposite Get the direction mark opposite to your language
3135 * @return string
3137 public function getDirMark( $opposite = false ) {
3138 $lrm = "\u{200E}"; # LEFT-TO-RIGHT MARK, commonly abbreviated LRM
3139 $rlm = "\u{200F}"; # RIGHT-TO-LEFT MARK, commonly abbreviated RLM
3140 if ( $opposite ) {
3141 return $this->isRTL() ? $lrm : $rlm;
3143 return $this->isRTL() ? $rlm : $lrm;
3147 * @return array
3149 public function capitalizeAllNouns() {
3150 return $this->localisationCache->getItem( $this->mCode, 'capitalizeAllNouns' );
3154 * An arrow, depending on the language direction.
3156 * @param string $direction The direction of the arrow: forwards (default),
3157 * backwards, left, right, up, down.
3158 * @return string
3160 public function getArrow( $direction = 'forwards' ) {
3161 switch ( $direction ) {
3162 case 'forwards':
3163 return $this->isRTL() ? '←' : '→';
3164 case 'backwards':
3165 return $this->isRTL() ? '→' : '←';
3166 case 'left':
3167 return '←';
3168 case 'right':
3169 return '→';
3170 case 'up':
3171 return '↑';
3172 case 'down':
3173 return '↓';
3178 * To allow "foo[[bar]]" to extend the link over the whole word "foobar"
3180 * @return bool
3182 public function linkPrefixExtension() {
3183 return $this->localisationCache->getItem( $this->mCode, 'linkPrefixExtension' );
3187 * Get all magic words from cache.
3188 * @return array
3190 public function getMagicWords() {
3191 return $this->localisationCache->getItem( $this->mCode, 'magicWords' );
3195 * Fill a MagicWord object with data from here
3197 * @param MagicWord $mw
3199 public function getMagic( $mw ) {
3200 $rawEntry = $this->mMagicExtensions[$mw->mId] ??
3201 $this->localisationCache->getSubitem( $this->mCode, 'magicWords', $mw->mId );
3203 if ( !is_array( $rawEntry ) ) {
3204 wfWarn( "\"$rawEntry\" is not a valid magic word for \"$mw->mId\"" );
3205 } else {
3206 $mw->mCaseSensitive = $rawEntry[0];
3207 $mw->mSynonyms = array_slice( $rawEntry, 1 );
3212 * Get special page names, as an associative array
3213 * canonical name => array of valid names, including aliases
3214 * @return array
3216 public function getSpecialPageAliases() {
3217 // Cache aliases because it may be slow to load them
3218 if ( $this->mExtendedSpecialPageAliases === null ) {
3219 // Initialise array
3220 $this->mExtendedSpecialPageAliases =
3221 $this->localisationCache->getItem( $this->mCode, 'specialPageAliases' );
3224 return $this->mExtendedSpecialPageAliases;
3228 * Italic is unsuitable for some languages
3230 * @param string $text The text to be emphasized.
3231 * @return string
3233 public function emphasize( $text ) {
3234 return "<em>$text</em>";
3238 * Normally we output all numbers in plain en_US style, that is
3239 * 293,291.235 for two hundred ninety-three thousand two hundred ninety-one
3240 * point two hundred thirty-five. However this is not suitable for all
3241 * languages, some such as Bengali (bn) want ২,৯৩,২৯১.২৩৫ and others such as
3242 * Icelandic just want to use commas instead of dots, and dots instead
3243 * of commas like "293.291,235".
3245 * An example of this function being called:
3246 * <code>
3247 * wfMessage( 'message' )->numParams( $num )->text()
3248 * </code>
3250 * See $separatorTransformTable on MessageIs.php for
3251 * the , => . and . => , implementation.
3253 * @param string|int|float $number Expected to be a pre-formatted (e.g. leading zeros, number
3254 * of decimal places) numeric string. Any non-string will be cast to string.
3255 * @param bool|null $noSeparators Set to true for special numbers like dates
3256 * (deprecated: use ::formatNumNoSeparators instead of this param)
3257 * @return string
3259 public function formatNum( $number, $noSeparators = null ) {
3260 if ( $noSeparators !== null ) {
3261 wfDeprecated( __METHOD__ . ' with $noSeparators parameter', '1.36' );
3262 } else {
3263 // The legacy default value.
3264 $noSeparators = false;
3266 return $this->formatNumInternal( (string)$number, false, $noSeparators );
3270 * Internal implementation function, shared between commafy, formatNum,
3271 * and formatNumNoSeparators.
3273 * @param string $number The stringification of a valid PHP number
3274 * @param bool $noTranslate Whether to translate digits and separators
3275 * @param bool $noSeparators Whether to add separators
3276 * @return string
3278 private function formatNumInternal(
3279 string $number, bool $noTranslate, bool $noSeparators
3280 ): string {
3281 global $wgTranslateNumerals;
3283 if ( $number === '' ) {
3284 return $number;
3286 if ( $number === (string)NAN ) {
3287 return $this->msg( 'formatnum-nan' )->text();
3289 if ( $number === (string)INF ) {
3290 return "∞";
3292 if ( $number === (string)-INF ) {
3293 return "\u{2212}∞";
3295 if ( !is_numeric( $number ) ) {
3296 # T267587: downgrade this to level:warn while we chase down the long
3297 # trail of callers.
3298 # wfDeprecated( 'Language::formatNum with a non-numeric string', '1.36' );
3299 LoggerFactory::getInstance( 'formatnum' )->warning(
3300 'Language::formatNum with non-numeric string',
3301 [ 'number' => $number ]
3303 $validNumberRe = '(-(?=[\d\.]))?(\d+|(?=\.\d))(\.\d*)?([Ee][-+]?\d+)?';
3304 // For backwards-compat, apply formatNum piecewise on the valid
3305 // numbers in the string. Don't split on NAN/INF in this legacy
3306 // case as they are likely to be found embedded inside non-numeric
3307 // text.
3308 return preg_replace_callback( "/{$validNumberRe}/", function ( $m ) use ( $noTranslate, $noSeparators ) {
3309 return $this->formatNumInternal( $m[0], $noTranslate, $noSeparators );
3310 }, $number );
3313 if ( !$noSeparators ) {
3314 $separatorTransformTable = $this->separatorTransformTable();
3315 $digitGroupingPattern = $this->digitGroupingPattern();
3316 $code = $this->getCode();
3317 if ( !( $wgTranslateNumerals && $this->langNameUtils->isValidCode( $code ) ) ) {
3318 $code = 'C'; // POSIX system default locale
3321 if ( $digitGroupingPattern ) {
3322 $fmt = new NumberFormatter(
3323 $code, NumberFormatter::PATTERN_DECIMAL, $digitGroupingPattern
3325 } else {
3326 /** @suppress PhanParamTooFew Phan thinks this always requires 3 parameters, that's wrong */
3327 $fmt = new NumberFormatter( $code, NumberFormatter::DECIMAL );
3330 // minimumGroupingDigits can be used to suppress groupings below a certain value.
3331 // This is used for languages such as Polish, where one would only write the grouping
3332 // separator for values above 9999 - numbers with more than 4 digits.
3333 // NumberFormatter is yet to support minimumGroupingDigits, ICU has it as experimental feature.
3334 // The attribute value is used by adding it to the grouping separator value. If
3335 // the input number has fewer integer digits, the grouping separator is suppressed.
3336 $minimumGroupingDigits = $this->minimumGroupingDigits() ?? 0;
3337 // Minimum length of a number to do digit grouping on.
3338 // http://unicode.org/reports/tr35/tr35-numbers.html#Examples_of_minimumGroupingDigits
3339 $minimumLength = $minimumGroupingDigits + $fmt->getAttribute( NumberFormatter::GROUPING_SIZE );
3340 if ( $minimumGroupingDigits && !preg_match( '/^\-?\d{' . $minimumLength . '}/', $number ) ) {
3341 // Even if number does not need commafy, do decimal
3342 // separator tranformation. For example 1234.56 becoms
3343 // 1234,56 in pl with $minimumGroupingDigits = 2
3344 if ( !$noTranslate ) {
3345 $number = strtr( $number, $separatorTransformTable ?: [] );
3347 } elseif ( $number === '-0' ) {
3348 // Special case to ensure we don't lose the minus sign by
3349 // converting to an int.
3350 if ( !$noTranslate ) {
3351 $number = strtr( $number, $separatorTransformTable ?: [] );
3353 } else {
3354 // NumberFormatter supports separator transformation,
3355 // but it does not know all languages MW
3356 // supports. Example: arq. Also, languages like pl has
3357 // customisation. So manually set it.
3358 if ( $noTranslate ) {
3359 $fmt->setSymbol(
3360 NumberFormatter::DECIMAL_SEPARATOR_SYMBOL,
3363 $fmt->setSymbol(
3364 NumberFormatter::GROUPING_SEPARATOR_SYMBOL,
3367 } elseif ( $separatorTransformTable ) {
3368 $fmt->setSymbol(
3369 NumberFormatter::DECIMAL_SEPARATOR_SYMBOL,
3370 $separatorTransformTable[ '.' ] ?? '.'
3372 $fmt->setSymbol(
3373 NumberFormatter::GROUPING_SEPARATOR_SYMBOL,
3374 $separatorTransformTable[ ',' ] ?? ','
3378 // Maintain # of digits before and after the decimal point
3379 // (and presence of decimal point)
3380 if ( preg_match( '/^-?(\d*)(\.(\d*))?$/', $number, $m ) ) {
3381 $fmt->setAttribute( NumberFormatter::MIN_INTEGER_DIGITS, strlen( $m[1] ) );
3382 if ( isset( $m[2] ) ) {
3383 $fmt->setAttribute( NumberFormatter::DECIMAL_ALWAYS_SHOWN, true );
3385 $fmt->setAttribute( NumberFormatter::FRACTION_DIGITS, strlen( $m[3] ?? '' ) );
3387 $number = $fmt->format( $number );
3391 if ( !$noTranslate ) {
3392 if ( $wgTranslateNumerals ) {
3393 // This is often unnecessary: PHP's NumberFormatter will often
3394 // do the digit transform itself (T267614)
3395 $s = $this->digitTransformTable();
3396 if ( $s ) {
3397 $number = strtr( $number, $s );
3400 # T10327: Make our formatted numbers prettier by using a
3401 # proper Unicode 'minus' character.
3402 $number = strtr( $number, [ '-' => "\u{2212}" ] );
3405 // Remove any LRM or RLM characters generated from NumberFormatter,
3406 // since directionality is handled outside of this context.
3407 // Similarly remove \u61C, the "Arabic Letter mark" (unicode 6.3.0)
3408 // https://en.wikipedia.org/wiki/Arabic_letter_mark
3409 // which is added starting PHP 7.3+
3410 $number = strtr( $number, [
3411 "\u{200E}" => '', // LRM
3412 "\u{200F}" => '', // RLM
3413 "\u{061C}" => '', // ALM
3414 ] );
3416 return $number;
3420 * Front-end for non-commafied formatNum
3422 * @param string|int|float $number The string to be formatted, should be an integer
3423 * or a floating point number.
3424 * @since 1.21
3425 * @return string
3427 public function formatNumNoSeparators( $number ) {
3428 return $this->formatNumInternal( (string)$number, false, true );
3432 * @param string $number
3433 * @return string
3435 public function parseFormattedNumber( $number ) {
3436 if ( $number === $this->msg( 'formatnum-nan' )->text() ) {
3437 return (string)NAN;
3439 if ( $number === "∞" ) {
3440 return (string)INF;
3442 // Accept either ASCII hyphen-minus or the unicode minus emitted by
3443 // ::formatNum()
3444 $number = strtr( $number, [ "\u{2212}" => '-' ] );
3445 if ( $number === "-∞" ) {
3446 return (string)-INF;
3448 $s = $this->digitTransformTable();
3449 if ( $s ) {
3450 // eliminate empty array values such as ''. (T66347)
3451 $s = array_filter( $s );
3452 $number = strtr( $number, array_flip( $s ) );
3455 $s = $this->separatorTransformTable();
3456 if ( $s ) {
3457 // eliminate empty array values such as ''. (T66347)
3458 $s = array_filter( $s );
3459 $number = strtr( $number, array_flip( $s ) );
3462 $number = strtr( $number, [ ',' => '' ] );
3463 return $number;
3467 * Adds commas to a given number. NumberFormatting class is used
3468 * when available for correct implementation as per tr35
3469 * specification of unicode.
3471 * @since 1.19
3472 * @deprecated in 1.36 use formatNum
3473 * @param string|null $number Expected to be a numeric string without (thousand) group
3474 * separators. Decimal seperator, if present, must be a dot. Any non-string will be cast to
3475 * string.
3476 * @return string
3478 public function commafy( $number ) {
3479 wfDeprecated( __METHOD__, '1.36' );
3480 // Validate the input argument.
3481 if ( $number === null || $number === '' ) {
3482 return '';
3484 return $this->formatNumInternal( $number, true, false );
3488 * @return string
3490 public function digitGroupingPattern() {
3491 return $this->localisationCache->getItem( $this->mCode, 'digitGroupingPattern' );
3495 * @return array
3497 public function digitTransformTable() {
3498 return $this->localisationCache->getItem( $this->mCode, 'digitTransformTable' );
3502 * @return array
3504 public function separatorTransformTable() {
3505 return $this->localisationCache->getItem( $this->mCode, 'separatorTransformTable' );
3509 * @return int|null
3511 public function minimumGroupingDigits() {
3512 return $this->localisationCache->getItem( $this->mCode, 'minimumGroupingDigits' );
3516 * Take a list of strings and build a locale-friendly comma-separated
3517 * list, using the local comma-separator message.
3518 * The last two strings are chained with an "and".
3520 * @param string[] $list
3521 * @return string
3523 public function listToText( array $list ) {
3524 $itemCount = count( $list );
3525 if ( $itemCount < 1 ) {
3526 return '';
3528 $text = array_pop( $list );
3529 if ( $itemCount > 1 ) {
3530 $and = $this->msg( 'and' )->escaped();
3531 $space = $this->msg( 'word-separator' )->escaped();
3532 $comma = '';
3533 if ( $itemCount > 2 ) {
3534 $comma = $this->msg( 'comma-separator' )->escaped();
3536 $text = implode( $comma, $list ) . $and . $space . $text;
3538 return $text;
3542 * Take a list of strings and build a locale-friendly comma-separated
3543 * list, using the local comma-separator message.
3544 * @param string[] $list Array of strings to put in a comma list
3545 * @return string
3547 public function commaList( array $list ) {
3548 return implode(
3549 wfMessage( 'comma-separator' )->inLanguage( $this )->escaped(),
3550 $list
3555 * Take a list of strings and build a locale-friendly semicolon-separated
3556 * list, using the local semicolon-separator message.
3557 * @param string[] $list Array of strings to put in a semicolon list
3558 * @return string
3560 public function semicolonList( array $list ) {
3561 return implode(
3562 wfMessage( 'semicolon-separator' )->inLanguage( $this )->escaped(),
3563 $list
3568 * Same as commaList, but separate it with the pipe instead.
3569 * @param string[] $list Array of strings to put in a pipe list
3570 * @return string
3572 public function pipeList( array $list ) {
3573 return implode(
3574 wfMessage( 'pipe-separator' )->inLanguage( $this )->escaped(),
3575 $list
3580 * Truncate a string to a specified length in bytes, appending an optional
3581 * string (e.g. for ellipsis)
3583 * If $length is negative, the string will be truncated from the beginning
3585 * @since 1.31
3587 * @param string $string String to truncate
3588 * @param int $length Maximum length in bytes
3589 * @param string $ellipsis String to append to the end of truncated text
3590 * @param bool $adjustLength Subtract length of ellipsis from $length
3592 * @return string
3594 public function truncateForDatabase( $string, $length, $ellipsis = '...', $adjustLength = true ) {
3595 return $this->truncateInternal(
3596 $string, $length, $ellipsis, $adjustLength, 'strlen', 'substr'
3601 * Truncate a string to a specified number of characters, appending an optional
3602 * string (e.g. for ellipsis).
3604 * This provides multibyte version of truncateForDatabase() method of this class,
3605 * suitable for truncation based on number of characters, instead of number of bytes.
3607 * If $length is negative, the string will be truncated from the beginning.
3609 * @since 1.31
3611 * @param string $string String to truncate
3612 * @param int $length Maximum number of characters
3613 * @param string $ellipsis String to append to the end of truncated text
3614 * @param bool $adjustLength Subtract length of ellipsis from $length
3616 * @return string
3618 public function truncateForVisual( $string, $length, $ellipsis = '...', $adjustLength = true ) {
3619 // Passing encoding to mb_strlen and mb_substr is optional.
3620 // Encoding defaults to mb_internal_encoding(), which is set to UTF-8 in Setup.php, so
3621 // explicit specification of encoding is skipped.
3622 // Note: Both multibyte methods are callables invoked in truncateInternal.
3623 return $this->truncateInternal(
3624 $string, $length, $ellipsis, $adjustLength, 'mb_strlen', 'mb_substr'
3629 * Internal method used for truncation. This method abstracts text truncation into
3630 * one common method, allowing users to provide length measurement function and
3631 * function for finding substring.
3633 * For usages, see truncateForDatabase and truncateForVisual.
3635 * @param string $string String to truncate
3636 * @param int $length Maximum length of final text
3637 * @param string $ellipsis String to append to the end of truncated text
3638 * @param bool $adjustLength Subtract length of ellipsis from $length
3639 * @param callable $measureLength Callable function used for determining the length of text
3640 * @param callable $getSubstring Callable function used for getting the substrings
3642 * @return string
3644 private function truncateInternal(
3645 $string, $length, $ellipsis, $adjustLength, callable $measureLength, callable $getSubstring
3647 # Check if there is no need to truncate
3648 if ( $measureLength( $string ) <= abs( $length ) ) {
3649 return $string; // no need to truncate
3652 # Use the localized ellipsis character
3653 if ( $ellipsis == '...' ) {
3654 $ellipsis = wfMessage( 'ellipsis' )->inLanguage( $this )->escaped();
3656 if ( $length == 0 ) {
3657 return $ellipsis; // convention
3660 $stringOriginal = $string;
3661 # If ellipsis length is >= $length then we can't apply $adjustLength
3662 if ( $adjustLength && $measureLength( $ellipsis ) >= abs( $length ) ) {
3663 $string = $ellipsis; // this can be slightly unexpected
3664 # Otherwise, truncate and add ellipsis...
3665 } else {
3666 $ellipsisLength = $adjustLength ? $measureLength( $ellipsis ) : 0;
3667 if ( $length > 0 ) {
3668 $length -= $ellipsisLength;
3669 $string = $getSubstring( $string, 0, $length ); // xyz...
3670 $string = $this->removeBadCharLast( $string );
3671 $string = rtrim( $string ) . $ellipsis;
3672 } else {
3673 $length += $ellipsisLength;
3674 $string = $getSubstring( $string, $length ); // ...xyz
3675 $string = $this->removeBadCharFirst( $string );
3676 $string = $ellipsis . ltrim( $string );
3680 # Do not truncate if the ellipsis makes the string longer/equal (T24181).
3681 # This check is *not* redundant if $adjustLength, due to the single case where
3682 # LEN($ellipsis) > ABS($limit arg); $stringOriginal could be shorter than $string.
3683 if ( $measureLength( $string ) < $measureLength( $stringOriginal ) ) {
3684 return $string;
3685 } else {
3686 return $stringOriginal;
3691 * Remove bytes that represent an incomplete Unicode character
3692 * at the end of string (e.g. bytes of the char are missing)
3694 * @param string $string
3695 * @return string
3697 protected function removeBadCharLast( $string ) {
3698 if ( $string != '' ) {
3699 $char = ord( $string[strlen( $string ) - 1] );
3700 $m = [];
3701 if ( $char >= 0xc0 ) {
3702 # We got the first byte only of a multibyte char; remove it.
3703 $string = substr( $string, 0, -1 );
3704 } elseif ( $char >= 0x80 &&
3705 // Use the /s modifier (PCRE_DOTALL) so (.*) also matches newlines
3706 preg_match( '/^(.*)(?:[\xe0-\xef][\x80-\xbf]|' .
3707 '[\xf0-\xf7][\x80-\xbf]{1,2})$/s', $string, $m )
3709 # We chopped in the middle of a character; remove it
3710 $string = $m[1];
3713 return $string;
3717 * Remove bytes that represent an incomplete Unicode character
3718 * at the start of string (e.g. bytes of the char are missing)
3720 * @param string $string
3721 * @return string
3723 protected function removeBadCharFirst( $string ) {
3724 if ( $string != '' ) {
3725 $char = ord( $string[0] );
3726 if ( $char >= 0x80 && $char < 0xc0 ) {
3727 # We chopped in the middle of a character; remove the whole thing
3728 $string = preg_replace( '/^[\x80-\xbf]+/', '', $string );
3731 return $string;
3735 * Truncate a string of valid HTML to a specified length in bytes,
3736 * appending an optional string (e.g. for ellipses), and return valid HTML
3738 * This is only intended for styled/linked text, such as HTML with
3739 * tags like <span> and <a>, were the tags are self-contained (valid HTML).
3740 * Also, this will not detect things like "display:none" CSS.
3742 * Note: since 1.18 you do not need to leave extra room in $length for ellipses.
3744 * @param string $text HTML string to truncate
3745 * @param int $length (zero/positive) Maximum length (including ellipses)
3746 * @param string $ellipsis String to append to the truncated text
3747 * @return string
3749 public function truncateHtml( $text, $length, $ellipsis = '...' ) {
3750 # Use the localized ellipsis character
3751 if ( $ellipsis == '...' ) {
3752 $ellipsis = wfMessage( 'ellipsis' )->inLanguage( $this )->escaped();
3754 # Check if there is clearly no need to truncate
3755 if ( $length <= 0 ) {
3756 return $ellipsis; // no text shown, nothing to format (convention)
3757 } elseif ( strlen( $text ) <= $length ) {
3758 return $text; // string short enough even *with* HTML (short-circuit)
3761 $dispLen = 0; // innerHTML legth so far
3762 $testingEllipsis = false; // checking if ellipses will make string longer/equal?
3763 $tagType = 0; // 0-open, 1-close
3764 $bracketState = 0; // 1-tag start, 2-tag name, 0-neither
3765 $entityState = 0; // 0-not entity, 1-entity
3766 $tag = $ret = ''; // accumulated tag name, accumulated result string
3767 $openTags = []; // open tag stack
3768 $maybeState = null; // possible truncation state
3770 $textLen = strlen( $text );
3771 $neLength = max( 0, $length - strlen( $ellipsis ) ); // non-ellipsis len if truncated
3772 for ( $pos = 0; true; ++$pos ) {
3773 # Consider truncation once the display length has reached the maximim.
3774 # We check if $dispLen > 0 to grab tags for the $neLength = 0 case.
3775 # Check that we're not in the middle of a bracket/entity...
3776 if ( $dispLen && $dispLen >= $neLength && $bracketState == 0 && !$entityState ) {
3777 if ( !$testingEllipsis ) {
3778 $testingEllipsis = true;
3779 # Save where we are; we will truncate here unless there turn out to
3780 # be so few remaining characters that truncation is not necessary.
3781 if ( !$maybeState ) { // already saved? ($neLength = 0 case)
3782 $maybeState = [ $ret, $openTags ]; // save state
3784 } elseif ( $dispLen > $length && $dispLen > strlen( $ellipsis ) ) {
3785 # String in fact does need truncation, the truncation point was OK.
3786 // @phan-suppress-next-line PhanTypeInvalidExpressionArrayDestructuring
3787 list( $ret, $openTags ) = $maybeState; // reload state
3788 $ret = $this->removeBadCharLast( $ret ); // multi-byte char fix
3789 $ret .= $ellipsis; // add ellipsis
3790 break;
3793 if ( $pos >= $textLen ) {
3794 break; // extra iteration just for above checks
3797 # Read the next char...
3798 $ch = $text[$pos];
3799 $lastCh = $pos ? $text[$pos - 1] : '';
3800 $ret .= $ch; // add to result string
3801 if ( $ch == '<' ) {
3802 $this->truncate_endBracket( $tag, $tagType, $lastCh, $openTags ); // for bad HTML
3803 $entityState = 0; // for bad HTML
3804 $bracketState = 1; // tag started (checking for backslash)
3805 } elseif ( $ch == '>' ) {
3806 $this->truncate_endBracket( $tag, $tagType, $lastCh, $openTags );
3807 $entityState = 0; // for bad HTML
3808 $bracketState = 0; // out of brackets
3809 } elseif ( $bracketState == 1 ) {
3810 if ( $ch == '/' ) {
3811 $tagType = 1; // close tag (e.g. "</span>")
3812 } else {
3813 $tagType = 0; // open tag (e.g. "<span>")
3814 $tag .= $ch;
3816 $bracketState = 2; // building tag name
3817 } elseif ( $bracketState == 2 ) {
3818 if ( $ch != ' ' ) {
3819 $tag .= $ch;
3820 } else {
3821 // Name found (e.g. "<a href=..."), add on tag attributes...
3822 $pos += $this->truncate_skip( $ret, $text, "<>", $pos + 1 );
3824 } elseif ( $bracketState == 0 ) {
3825 if ( $entityState ) {
3826 if ( $ch == ';' ) {
3827 $entityState = 0;
3828 $dispLen++; // entity is one displayed char
3830 } else {
3831 if ( $neLength == 0 && !$maybeState ) {
3832 // Save state without $ch. We want to *hit* the first
3833 // display char (to get tags) but not *use* it if truncating.
3834 $maybeState = [ substr( $ret, 0, -1 ), $openTags ];
3836 if ( $ch == '&' ) {
3837 $entityState = 1; // entity found, (e.g. "&#160;")
3838 } else {
3839 $dispLen++; // this char is displayed
3840 // Add the next $max display text chars after this in one swoop...
3841 $max = ( $testingEllipsis ? $length : $neLength ) - $dispLen;
3842 $skipped = $this->truncate_skip( $ret, $text, "<>&", $pos + 1, $max );
3843 $dispLen += $skipped;
3844 $pos += $skipped;
3849 // Close the last tag if left unclosed by bad HTML
3850 $this->truncate_endBracket( $tag, $text[$textLen - 1], $tagType, $openTags );
3851 while ( count( $openTags ) > 0 ) {
3852 $ret .= '</' . array_pop( $openTags ) . '>'; // close open tags
3854 return $ret;
3858 * truncateHtml() helper function
3859 * like strcspn() but adds the skipped chars to $ret
3861 * @param string &$ret
3862 * @param string $text
3863 * @param string $search
3864 * @param int $start
3865 * @param null|int $len
3866 * @return int
3868 private function truncate_skip( &$ret, $text, $search, $start, $len = null ) {
3869 if ( $len === null ) {
3870 $len = -1; // -1 means "no limit" for strcspn
3871 } elseif ( $len < 0 ) {
3872 $len = 0; // sanity
3874 $skipCount = 0;
3875 if ( $start < strlen( $text ) ) {
3876 $skipCount = strcspn( $text, $search, $start, $len );
3877 $ret .= substr( $text, $start, $skipCount );
3879 return $skipCount;
3883 * truncateHtml() helper function
3884 * (a) push or pop $tag from $openTags as needed
3885 * (b) clear $tag value
3886 * @param string &$tag Current HTML tag name we are looking at
3887 * @param int $tagType (0-open tag, 1-close tag)
3888 * @param string $lastCh Character before the '>' that ended this tag
3889 * @param array &$openTags Open tag stack (not accounting for $tag)
3891 private function truncate_endBracket( &$tag, $tagType, $lastCh, &$openTags ) {
3892 $tag = ltrim( $tag );
3893 if ( $tag != '' ) {
3894 if ( $tagType == 0 && $lastCh != '/' ) {
3895 $openTags[] = $tag; // tag opened (didn't close itself)
3896 } elseif ( $tagType == 1 ) {
3897 if ( $openTags && $tag == $openTags[count( $openTags ) - 1] ) {
3898 array_pop( $openTags ); // tag closed
3901 $tag = '';
3906 * Grammatical transformations, needed for inflected languages
3907 * Invoked by putting {{grammar:case|word}} in a message
3909 * @param string $word
3910 * @param string $case
3911 * @return string
3913 public function convertGrammar( $word, $case ) {
3914 global $wgGrammarForms;
3915 if ( isset( $wgGrammarForms[$this->getCode()][$case][$word] ) ) {
3916 return $wgGrammarForms[$this->getCode()][$case][$word];
3919 $grammarTransformations = $this->getGrammarTransformations();
3921 if ( isset( $grammarTransformations[$case] ) ) {
3922 $forms = $grammarTransformations[$case];
3924 // Some names of grammar rules are aliases for other rules.
3925 // In such cases the value is a string rather than object,
3926 // so load the actual rules.
3927 if ( is_string( $forms ) ) {
3928 $forms = $grammarTransformations[$forms];
3931 foreach ( array_values( $forms ) as $rule ) {
3932 $form = $rule[0];
3934 if ( $form === '@metadata' ) {
3935 continue;
3938 $replacement = $rule[1];
3940 $regex = '/' . addcslashes( $form, '/' ) . '/u';
3941 $patternMatches = preg_match( $regex, $word );
3943 if ( $patternMatches === false ) {
3944 wfLogWarning(
3945 'An error occurred while processing grammar. ' .
3946 "Word: '$word'. Regex: /$form/."
3948 } elseif ( $patternMatches === 1 ) {
3949 $word = preg_replace( $regex, $replacement, $word );
3951 break;
3956 return $word;
3960 * Get the grammar forms for the content language
3961 * @return array Array of grammar forms
3962 * @since 1.20
3964 public function getGrammarForms() {
3965 global $wgGrammarForms;
3966 if ( isset( $wgGrammarForms[$this->getCode()] )
3967 && is_array( $wgGrammarForms[$this->getCode()] )
3969 return $wgGrammarForms[$this->getCode()];
3972 return [];
3976 * Get the grammar transformations data for the language.
3977 * Used like grammar forms, with {{GRAMMAR}} and cases,
3978 * but uses pairs of regexes and replacements instead of code.
3980 * @return array[] Array of grammar transformations.
3981 * @throws MWException
3982 * @since 1.28
3984 public function getGrammarTransformations() {
3985 if ( $this->grammarTransformCache !== null ) {
3986 return $this->grammarTransformCache;
3989 $grammarDataFile = __DIR__ . "/data/grammarTransformations/{$this->getCode()}.json";
3991 $this->grammarTransformCache = is_readable( $grammarDataFile )
3992 ? FormatJson::decode( file_get_contents( $grammarDataFile ), true )
3993 : [];
3995 if ( $this->grammarTransformCache === null ) {
3996 throw new MWException( "Invalid grammar data for \"{$this->getCode()}\"." );
3999 return $this->grammarTransformCache;
4003 * Provides an alternative text depending on specified gender.
4004 * Usage {{gender:username|masculine|feminine|unknown}}.
4005 * username is optional, in which case the gender of current user is used,
4006 * but only in (some) interface messages; otherwise default gender is used.
4008 * If no forms are given, an empty string is returned. If only one form is
4009 * given, it will be returned unconditionally. These details are implied by
4010 * the caller and cannot be overridden in subclasses.
4012 * If three forms are given, the default is to use the third (unknown) form.
4013 * If fewer than three forms are given, the default is to use the first (masculine) form.
4014 * These details can be overridden in subclasses.
4016 * @param string $gender
4017 * @param array $forms
4019 * @return string
4021 public function gender( $gender, $forms ) {
4022 if ( !count( $forms ) ) {
4023 return '';
4025 $forms = $this->preConvertPlural( $forms, 2 );
4026 if ( $gender === 'male' ) {
4027 return $forms[0];
4029 if ( $gender === 'female' ) {
4030 return $forms[1];
4032 return $forms[2] ?? $forms[0];
4036 * Plural form transformations, needed for some languages.
4037 * For example, there are 3 form of plural in Russian and Polish,
4038 * depending on "count mod 10". See [[w:Plural]]
4039 * For English it is pretty simple.
4041 * Invoked by putting {{plural:count|wordform1|wordform2}}
4042 * or {{plural:count|wordform1|wordform2|wordform3}}
4044 * Example: {{plural:{{NUMBEROFARTICLES}}|article|articles}}
4046 * @param int $count Non-localized number
4047 * @param array $forms Different plural forms
4048 * @return string Correct form of plural for $count in this language
4050 public function convertPlural( $count, $forms ) {
4051 // Handle explicit n=pluralform cases
4052 $forms = $this->handleExplicitPluralForms( $count, $forms );
4053 if ( is_string( $forms ) ) {
4054 return $forms;
4056 if ( !count( $forms ) ) {
4057 return '';
4060 $pluralForm = $this->getPluralRuleIndexNumber( $count );
4061 $pluralForm = min( $pluralForm, count( $forms ) - 1 );
4062 return $forms[$pluralForm];
4066 * Handles explicit plural forms for Language::convertPlural()
4068 * In {{PLURAL:$1|0=nothing|one|many}}, 0=nothing will be returned if $1 equals zero.
4069 * If an explicitly defined plural form matches the $count, then
4070 * string value returned, otherwise array returned for further consideration
4071 * by CLDR rules or overridden convertPlural().
4073 * @since 1.23
4075 * @param int $count Non-localized number
4076 * @param array $forms Different plural forms
4078 * @return array|string
4080 protected function handleExplicitPluralForms( $count, array $forms ) {
4081 foreach ( $forms as $index => $form ) {
4082 if ( preg_match( '/\d+=/i', $form ) ) {
4083 $pos = strpos( $form, '=' );
4084 if ( substr( $form, 0, $pos ) === (string)$count ) {
4085 return substr( $form, $pos + 1 );
4087 unset( $forms[$index] );
4090 return array_values( $forms );
4094 * Checks that convertPlural was given an array and pads it to requested
4095 * amount of forms by copying the last one.
4097 * @param array $forms
4098 * @param int $count How many forms should there be at least
4099 * @return array Padded array of forms
4101 protected function preConvertPlural( /* Array */ $forms, $count ) {
4102 return array_pad( $forms, $count, end( $forms ) );
4106 * Wraps argument with unicode control characters for directionality safety
4108 * This solves the problem where directionality-neutral characters at the edge of
4109 * the argument string get interpreted with the wrong directionality from the
4110 * enclosing context, giving renderings that look corrupted like "(Ben_(WMF".
4112 * The wrapping is LRE...PDF or RLE...PDF, depending on the detected
4113 * directionality of the argument string, using the BIDI algorithm's own "First
4114 * strong directional codepoint" rule. Essentially, this works round the fact that
4115 * there is no embedding equivalent of U+2068 FSI (isolation with heuristic
4116 * direction inference). The latter is cleaner but still not widely supported.
4118 * @param string $text Text to wrap
4119 * @return string Text, wrapped in LRE...PDF or RLE...PDF or nothing
4121 public function embedBidi( $text = '' ) {
4122 $dir = self::strongDirFromContent( $text );
4123 if ( $dir === 'ltr' ) {
4124 // Wrap in LEFT-TO-RIGHT EMBEDDING ... POP DIRECTIONAL FORMATTING
4125 return self::LRE . $text . self::PDF;
4127 if ( $dir === 'rtl' ) {
4128 // Wrap in RIGHT-TO-LEFT EMBEDDING ... POP DIRECTIONAL FORMATTING
4129 return self::RLE . $text . self::PDF;
4131 // No strong directionality: do not wrap
4132 return $text;
4136 * @todo Maybe translate block durations. Note that this function is somewhat misnamed: it
4137 * deals with translating the *duration* ("1 week", "4 days", etc), not the expiry time
4138 * (which is an absolute timestamp). Please note: do NOT add this blindly, as it is used
4139 * on old expiry lengths recorded in log entries. You'd need to provide the start date to
4140 * match up with it.
4142 * @param string $str The validated block duration in English
4143 * @param User|null $user User object to use timezone from or null for the context user
4144 * @param int $now Current timestamp, for formatting relative block durations
4145 * @return string Somehow translated block duration
4146 * @see LanguageFi.php for example implementation
4148 public function translateBlockExpiry( $str, User $user = null, $now = 0 ) {
4149 $duration = SpecialBlock::getSuggestedDurations( $this );
4150 foreach ( $duration as $show => $value ) {
4151 if ( strcmp( $str, $value ) == 0 ) {
4152 return trim( $show );
4156 if ( wfIsInfinity( $str ) ) {
4157 foreach ( $duration as $show => $value ) {
4158 if ( wfIsInfinity( $value ) ) {
4159 return trim( $show );
4164 // If all else fails, return a standard duration or timestamp description.
4165 $time = strtotime( $str, $now );
4166 if ( $time === false ) { // Unknown format. Return it as-is in case.
4167 return $str;
4168 } elseif ( $time !== strtotime( $str, $now + 1 ) ) { // It's a relative timestamp.
4169 // The result differs based on current time, so the difference
4170 // is a fixed duration length.
4171 return $this->formatDuration( $time - $now );
4172 } else { // It's an absolute timestamp.
4173 if ( $time === 0 ) {
4174 // wfTimestamp() handles 0 as current time instead of epoch.
4175 $time = '19700101000000';
4177 if ( $user ) {
4178 return $this->userTimeAndDate( $time, $user );
4180 return $this->timeanddate( $time );
4185 * languages like Chinese need to be segmented in order for the diff
4186 * to be of any use
4188 * @param string $text
4189 * @return string
4191 public function segmentForDiff( $text ) {
4192 return $text;
4196 * and unsegment to show the result
4198 * @param string $text
4199 * @return string
4201 public function unsegmentForDiff( $text ) {
4202 return $text;
4206 * Return the LanguageConverter used in the Language
4208 * @since 1.19
4209 * @deprecated since 1.35 Use MediaWikiServices::getInstance()->getLanguageConverterFactory()
4210 * ->getLanguageConverter( $language ) instead
4212 * @return ILanguageConverter
4214 public function getConverter() : ILanguageConverter {
4215 return $this->converterFactory->getLanguageConverter( $this );
4219 * convert text to a variant
4221 * @deprecated since 1.35 use LanguageConverter::autoConvert
4223 * @param string $text text to convert
4224 * @param string|bool $variant variant to convert to, or false to use the user's preferred
4225 * variant (if logged in), or the project default variant
4226 * @return string the converted string
4228 public function autoConvert( $text, $variant = false ) {
4229 return $this->getConverter()->autoConvert( $text, $variant );
4233 * convert text to all supported variants
4235 * @deprecated since 1.35 use LanguageConverter::autoConvertToAllVariants
4237 * @param string $text
4238 * @return array
4240 public function autoConvertToAllVariants( $text ) {
4241 return $this->getConverter()->autoConvertToAllVariants( $text );
4245 * convert text to different variants of a language.
4247 * @warning Glossary state is maintained between calls. This means
4248 * if you pass unescaped text to this method it can cause an XSS
4249 * in later calls to this method, even if the later calls have properly
4250 * escaped the input. Never feed this method user controlled text that
4251 * is not properly escaped!
4253 * @deprecated since 1.35 use LanguageConverter::convert
4255 * @param string $text Content that has been already escaped for use in HTML
4256 * @return string HTML
4258 public function convert( $text ) {
4259 return $this->getConverter()->convert( $text );
4263 * Convert a Title object to a string in the preferred variant
4265 * @deprecated since 1.35 use LanguageConverter::convertTitle
4267 * @param Title $title
4268 * @return string
4270 public function convertTitle( $title ) {
4271 wfDeprecated( __METHOD__, '1.35' );
4272 return $this->getConverter()->convertTitle( $title );
4276 * Convert a namespace index to a string in the preferred variant
4278 * @deprecated since 1.35 use LanguageConverter::convertNamespace instead
4280 * @param int $ns namespace index (https://www.mediawiki.org/wiki/Manual:Namespace)
4281 * @param string|null $variant variant to convert to, or null to use the user's preferred
4282 * variant (if logged in), or the project default variant
4283 * @return string a string representation of the namespace
4285 public function convertNamespace( $ns, $variant = null ) {
4286 return $this->getConverter()->convertNamespace( $ns, $variant );
4290 * Check if this is a language with variants
4292 * @deprecated since 1.35 use LanguageConverter::hasVariants instead
4294 * @return bool
4296 public function hasVariants() {
4297 return count( $this->getVariants() ) > 1;
4301 * Strict check if the language has the specific variant.
4303 * Compare to LanguageConverter::validateVariant() which does a more
4304 * lenient check and attempts to coerce the given code to a valid one.
4306 * @deprecated since 1.35 use LanguageConverter::hasVariant instead
4308 * @since 1.19
4309 * @param string $variant
4310 * @return bool
4312 public function hasVariant( $variant ) {
4313 return $this->getConverter()->hasVariant( $variant );
4317 * Perform output conversion on a string, and encode for safe HTML output.
4319 * @deprecated since 1.35 use LanguageConverter::convertHtml instead
4321 * @param string $text Text to be converted
4322 * @return string
4323 * @todo this should get integrated somewhere sane
4325 public function convertHtml( $text ) {
4326 return htmlspecialchars( $this->convert( $text ) );
4330 * @deprecated since 1.35 use LanguageConverter::convertCategoryKey instead
4332 * @param string $key
4333 * @return string
4335 public function convertCategoryKey( $key ) {
4336 return $this->getConverter()->convertCategoryKey( $key );
4340 * Get the list of variants supported by this language
4341 * see sample implementation in LanguageZh.php
4343 * @deprecated since 1.35 use LanguageConverter::getVariants instead
4345 * @return string[] An array of language codes
4347 public function getVariants() {
4348 return $this->getConverter()->getVariants();
4352 * @deprecated since 1.35 use LanguageConverter::getPreferredVariant instead
4353 * @return string
4355 public function getPreferredVariant() {
4356 return $this->getConverter()->getPreferredVariant();
4360 * @deprecated since 1.35 use LanguageConverter::getDefaultVariant instead
4361 * @return string
4363 public function getDefaultVariant() {
4364 return $this->getConverter()->getDefaultVariant();
4368 * @deprecated since 1.35 use LanguageConverter::getURLVariant instead
4369 * @return string
4371 public function getURLVariant() {
4372 return $this->getConverter()->getURLVariant();
4376 * If a language supports multiple variants, it is
4377 * possible that non-existing link in one variant
4378 * actually exists in another variant. this function
4379 * tries to find it. See e.g. LanguageZh.php
4380 * The input parameters may be modified upon return
4382 * @deprecated since 1.35 use LanguageConverter::findVariantLink instead
4384 * @param string &$link The name of the link
4385 * @param Title &$nt The title object of the link
4386 * @param bool $ignoreOtherCond To disable other conditions when
4387 * we need to transclude a template or update a category's link
4389 public function findVariantLink( &$link, &$nt, $ignoreOtherCond = false ) {
4390 wfDeprecated( __METHOD__, '1.35' );
4391 $this->getConverter()->findVariantLink( $link, $nt, $ignoreOtherCond );
4395 * returns language specific options used by User::getPageRenderHash()
4396 * for example, the preferred language variant
4398 * @deprecated since 1.35 use LanguageConverter::getExtraHashOptions instead
4400 * @return string
4402 public function getExtraHashOptions() {
4403 return $this->getConverter()->getExtraHashOptions();
4407 * Refresh the cache of conversion tables when
4408 * MediaWiki:Conversiontable* is updated.
4410 * @deprecated since 1.35 use LanguageConverter::updateConversionTable instead
4412 * @param LinkTarget $linkTarget The LinkTarget of the page being updated
4414 public function updateConversionTable( LinkTarget $linkTarget ) {
4415 wfDeprecated( __METHOD__, '1.35' );
4416 $this->getConverter()->updateConversionTable( $linkTarget );
4420 * A regular expression to match legal word-trailing characters
4421 * which should be merged onto a link of the form [[foo]]bar.
4423 * @return string
4425 public function linkTrail() {
4426 return $this->localisationCache->getItem( $this->mCode, 'linkTrail' );
4430 * A regular expression character set to match legal word-prefixing
4431 * characters which should be merged onto a link of the form foo[[bar]].
4433 * @return string
4435 public function linkPrefixCharset() {
4436 return $this->localisationCache->getItem( $this->mCode, 'linkPrefixCharset' );
4440 * Get the "parent" language which has a converter to convert a "compatible" language
4441 * (in another variant) to this language (eg. zh for zh-cn, but not en for en-gb).
4443 * @deprecated since 1.35, use LanguageFactory::getParentLanguage
4444 * @return Language|null
4445 * @since 1.22
4447 public function getParentLanguage() {
4448 return MediaWikiServices::getInstance()->getLanguageFactory()
4449 ->getParentLanguage( $this->getCode() );
4453 * Compare with an other language object
4455 * @since 1.28
4456 * @param Language $lang
4457 * @return bool
4459 public function equals( Language $lang ) {
4460 return $lang === $this || $lang->getCode() === $this->mCode;
4464 * Get the internal language code for this language object
4466 * NOTE: The return value of this function is NOT HTML-safe and must be escaped with
4467 * htmlspecialchars() or similar
4469 * @return string
4471 public function getCode() {
4472 return $this->mCode;
4476 * Get the code in BCP 47 format which we can use
4477 * inside of html lang="" tags.
4479 * NOTE: The return value of this function is NOT HTML-safe and must be escaped with
4480 * htmlspecialchars() or similar.
4482 * @since 1.19
4483 * @return string
4485 public function getHtmlCode() {
4486 if ( $this->mHtmlCode === null ) {
4487 $this->mHtmlCode = LanguageCode::bcp47( $this->getCode() );
4489 return $this->mHtmlCode;
4493 * Get the language code from a file name. Inverse of getFileName()
4494 * @param string $filename $prefix . $languageCode . $suffix
4495 * @param string $prefix Prefix before the language code
4496 * @param string $suffix Suffix after the language code
4497 * @return string Language code, or false if $prefix or $suffix isn't found
4499 public static function getCodeFromFileName( $filename, $prefix = 'Language', $suffix = '.php' ) {
4500 $m = null;
4501 preg_match( '/' . preg_quote( $prefix, '/' ) . '([A-Z][a-z_]+)' .
4502 preg_quote( $suffix, '/' ) . '/', $filename, $m );
4503 if ( !count( $m ) ) {
4504 return false;
4506 return str_replace( '_', '-', strtolower( $m[1] ) );
4510 * @deprecated since 1.35, this is an internal method and should not need
4511 * to be used elsewhere
4513 * @param string $code
4514 * @param bool $fallback Whether we're going through language fallback chain
4515 * @return string Name of the language class
4517 public static function classFromCode( $code, $fallback = true ) {
4518 wfDeprecated( __METHOD__, '1.35' );
4520 if ( $fallback && $code == 'en' ) {
4521 return 'Language';
4522 } else {
4523 return 'Language' . str_replace( '-', '_', ucfirst( $code ) );
4528 * Get the name of a file for a certain language code
4530 * @deprecated since 1.34, use LanguageNameUtils
4531 * @param string $prefix Prepend this to the filename
4532 * @param string $code Language code
4533 * @param string $suffix Append this to the filename
4534 * @throws MWException
4535 * @return string $prefix . $mangledCode . $suffix
4537 public static function getFileName( $prefix, $code, $suffix = '.php' ) {
4538 return MediaWikiServices::getInstance()->getLanguageNameUtils()
4539 ->getFileName( $prefix, $code, $suffix );
4543 * @deprecated since 1.34, use LanguageNameUtils
4544 * @param string $code
4545 * @return string
4547 public static function getMessagesFileName( $code ) {
4548 return MediaWikiServices::getInstance()->getLanguageNameUtils()
4549 ->getMessagesFileName( $code );
4553 * @deprecated since 1.34, use LanguageNameUtils
4554 * @param string $code
4555 * @return string
4556 * @throws MWException
4557 * @since 1.23
4559 public static function getJsonMessagesFileName( $code ) {
4560 return MediaWikiServices::getInstance()->getLanguageNameUtils()
4561 ->getJsonMessagesFileName( $code );
4565 * Get the first fallback for a given language.
4567 * @deprecated since 1.35, use LanguageFallback::getFirst
4569 * @param string $code
4570 * @return string|false False if no fallbacks
4572 public static function getFallbackFor( $code ) {
4573 return MediaWikiServices::getInstance()->getLanguageFallback()->getFirst( $code )
4574 ?? false;
4578 * Get the ordered list of fallback languages.
4580 * @deprecated since 1.35, use LanguageFallback::getAll
4582 * @since 1.19
4583 * @param string $code Language code
4584 * @param int $mode Fallback mode, either MESSAGES_FALLBACKS (which always falls back to 'en'),
4585 * or STRICT_FALLBACKS (which only falls back to 'en' when explicitly defined)
4586 * @throws InvalidArgumentException
4587 * @return array List of language codes
4589 public static function getFallbacksFor( $code, $mode = LanguageFallback::MESSAGES ) {
4590 return MediaWikiServices::getInstance()->getLanguageFallback()->getAll( $code, $mode );
4594 * Get the ordered list of fallback languages, ending with the fallback
4595 * language chain for the site language.
4597 * @deprecated since 1.35, use LanguageFallback::getAllIncludingSiteLanguage
4599 * @since 1.22
4600 * @param string $code Language code
4601 * @return array [ fallbacks, site fallbacks ]
4603 public static function getFallbacksIncludingSiteLanguage( $code ) {
4604 return MediaWikiServices::getInstance()->getLanguageFallback()
4605 ->getAllIncludingSiteLanguage( $code );
4609 * Get all messages for a given language
4610 * WARNING: this may take a long time. If you just need all message *keys*
4611 * but need the *contents* of only a few messages, consider using getMessageKeysFor().
4613 * @deprecated since 1.35, use LocalisationCache directly
4615 * @param string $code
4617 * @return array
4619 public static function getMessagesFor( $code ) {
4620 return self::getLocalisationCache()->getItem( $code, 'messages' );
4624 * Get a message for a given language
4626 * @deprecated since 1.35, use LocalisationCache directly
4628 * @param string $key
4629 * @param string $code
4631 * @return string
4633 public static function getMessageFor( $key, $code ) {
4634 return self::getLocalisationCache()->getSubitem( $code, 'messages', $key );
4638 * Get all message keys for a given language. This is a faster alternative to
4639 * array_keys( Language::getMessagesFor( $code ) )
4641 * @deprecated since 1.35, use LocalisationCache directly
4643 * @since 1.19
4644 * @param string $code Language code
4645 * @return array Array of message keys (strings)
4647 public static function getMessageKeysFor( $code ) {
4648 return self::getLocalisationCache()->getSubitemList( $code, 'messages' );
4652 * @param string $talk
4653 * @return string
4655 private function fixVariableInNamespace( $talk ) {
4656 if ( strpos( $talk, '$1' ) === false ) {
4657 return $talk;
4660 global $wgMetaNamespace;
4661 $talk = str_replace( '$1', $wgMetaNamespace, $talk );
4663 # Allow grammar transformations
4664 # Allowing full message-style parsing would make simple requests
4665 # such as action=raw much more expensive than they need to be.
4666 # This will hopefully cover most cases.
4667 $talk = preg_replace_callback(
4668 '/{{grammar:(.*?)\|(.*?)}}/i',
4669 function ( $m ) {
4670 return $this->convertGrammar( trim( $m[2] ), trim( $m[1] ) );
4672 $talk
4674 return str_replace( ' ', '_', $talk );
4678 * Decode an expiry (block, protection, etc) which has come from the DB
4680 * @param string $expiry Database expiry String
4681 * @param bool|int $format True to process using language functions, or TS_ constant
4682 * to return the expiry in a given timestamp
4683 * @param string $infinity If $format is not true, use this string for infinite expiry
4684 * @param User|null $user If $format is true, use this user for date format
4685 * @return string
4686 * @since 1.18
4687 * @since 1.36 $user was added
4689 public function formatExpiry( $expiry, $format = true, $infinity = 'infinity', $user = null ) {
4690 static $dbInfinity;
4691 if ( $dbInfinity === null ) {
4692 $dbInfinity = wfGetDB( DB_REPLICA )->getInfinity();
4695 if ( $expiry == '' || $expiry === 'infinity' || $expiry == $dbInfinity ) {
4696 return $format === true
4697 ? $this->getMessageFromDB( 'infiniteblock' )
4698 : $infinity;
4699 } else {
4700 if ( $format === true ) {
4701 return $user
4702 ? $this->userTimeAndDate( $expiry, $user )
4703 : $this->timeanddate( $expiry, /* User preference timezone */ true );
4705 return wfTimestamp( $format, $expiry );
4710 * Formats a time given in seconds into a string representation of that time.
4712 * @param int|float $seconds
4713 * @param array $format An optional argument that formats the returned string in different ways:
4714 * If $format['avoid'] === 'avoidhours': don't show hours, just show days
4715 * If $format['avoid'] === 'avoidseconds': don't show seconds if $seconds >= 1 hour,
4716 * If $format['avoid'] === 'avoidminutes': don't show seconds/minutes if $seconds > 48 hours,
4717 * If $format['noabbrevs'] is true: use 'seconds' and friends instead of 'seconds-abbrev'
4718 * and friends.
4719 * @note For backwards compatibility, $format may also be one of the strings 'avoidseconds'
4720 * or 'avoidminutes'.
4721 * @return string
4723 public function formatTimePeriod( $seconds, $format = [] ) {
4724 if ( !is_array( $format ) ) {
4725 $format = [ 'avoid' => $format ]; // For backwards compatibility
4727 if ( !isset( $format['avoid'] ) ) {
4728 $format['avoid'] = false;
4730 if ( !isset( $format['noabbrevs'] ) ) {
4731 $format['noabbrevs'] = false;
4733 $secondsMsg = wfMessage(
4734 $format['noabbrevs'] ? 'seconds' : 'seconds-abbrev' )->inLanguage( $this );
4735 $minutesMsg = wfMessage(
4736 $format['noabbrevs'] ? 'minutes' : 'minutes-abbrev' )->inLanguage( $this );
4737 $hoursMsg = wfMessage(
4738 $format['noabbrevs'] ? 'hours' : 'hours-abbrev' )->inLanguage( $this );
4739 $daysMsg = wfMessage(
4740 $format['noabbrevs'] ? 'days' : 'days-abbrev' )->inLanguage( $this );
4742 if ( round( $seconds * 10 ) < 100 ) {
4743 $s = $this->formatNum( sprintf( "%.1f", round( $seconds * 10 ) / 10 ) );
4744 $s = $secondsMsg->params( $s )->text();
4745 } elseif ( round( $seconds ) < 60 ) {
4746 $s = $this->formatNum( round( $seconds ) );
4747 $s = $secondsMsg->params( $s )->text();
4748 } elseif ( round( $seconds ) < 3600 ) {
4749 $minutes = floor( $seconds / 60 );
4750 $secondsPart = round( fmod( $seconds, 60 ) );
4751 if ( $secondsPart == 60 ) {
4752 $secondsPart = 0;
4753 $minutes++;
4755 $s = $minutesMsg->params( $this->formatNum( $minutes ) )->text();
4756 $s .= ' ';
4757 $s .= $secondsMsg->params( $this->formatNum( $secondsPart ) )->text();
4758 } elseif ( round( $seconds ) <= 2 * 86400 ) {
4759 $hours = floor( $seconds / 3600 );
4760 $minutes = floor( ( $seconds - $hours * 3600 ) / 60 );
4761 $secondsPart = round( $seconds - $hours * 3600 - $minutes * 60 );
4762 if ( $secondsPart == 60 ) {
4763 $secondsPart = 0;
4764 $minutes++;
4766 if ( $minutes == 60 ) {
4767 $minutes = 0;
4768 $hours++;
4770 $s = $hoursMsg->params( $this->formatNum( $hours ) )->text();
4771 $s .= ' ';
4772 $s .= $minutesMsg->params( $this->formatNum( $minutes ) )->text();
4773 if ( !in_array( $format['avoid'], [ 'avoidseconds', 'avoidminutes', 'avoidhours' ] ) ) {
4774 $s .= ' ' . $secondsMsg->params( $this->formatNum( $secondsPart ) )->text();
4776 } else {
4777 $days = floor( $seconds / 86400 );
4778 if ( $format['avoid'] === 'avoidhours' ) {
4779 $hours = round( ( $seconds - $days * 86400 ) / 3600 );
4780 if ( $hours == 24 ) {
4781 $hours = 0;
4782 $days++;
4784 $s = $daysMsg->params( $this->formatNum( $days ) )->text();
4785 } elseif ( $format['avoid'] === 'avoidminutes' ) {
4786 $hours = round( ( $seconds - $days * 86400 ) / 3600 );
4787 if ( $hours == 24 ) {
4788 $hours = 0;
4789 $days++;
4791 $s = $daysMsg->params( $this->formatNum( $days ) )->text();
4792 $s .= ' ';
4793 $s .= $hoursMsg->params( $this->formatNum( $hours ) )->text();
4794 } elseif ( $format['avoid'] === 'avoidseconds' ) {
4795 $hours = floor( ( $seconds - $days * 86400 ) / 3600 );
4796 $minutes = round( ( $seconds - $days * 86400 - $hours * 3600 ) / 60 );
4797 if ( $minutes == 60 ) {
4798 $minutes = 0;
4799 $hours++;
4801 if ( $hours == 24 ) {
4802 $hours = 0;
4803 $days++;
4805 $s = $daysMsg->params( $this->formatNum( $days ) )->text();
4806 $s .= ' ';
4807 $s .= $hoursMsg->params( $this->formatNum( $hours ) )->text();
4808 $s .= ' ';
4809 $s .= $minutesMsg->params( $this->formatNum( $minutes ) )->text();
4810 } else {
4811 $s = $daysMsg->params( $this->formatNum( $days ) )->text();
4812 $s .= ' ';
4813 $s .= $this->formatTimePeriod( $seconds - $days * 86400, $format );
4816 return $s;
4820 * Format a bitrate for output, using an appropriate
4821 * unit (bps, kbps, Mbps, Gbps, Tbps, Pbps, Ebps, Zbps or Ybps) according to
4822 * the magnitude in question.
4824 * This use base 1000. For base 1024 use formatSize(), for another base
4825 * see formatComputingNumbers().
4827 * @param int $bps
4828 * @return string
4830 public function formatBitrate( $bps ) {
4831 return $this->formatComputingNumbers( $bps, 1000, "bitrate-$1bits" );
4835 * @param int $size Size of the unit
4836 * @param int $boundary Size boundary (1000, or 1024 in most cases)
4837 * @param string $messageKey Message key to be used
4838 * @return string
4840 public function formatComputingNumbers( $size, $boundary, $messageKey ) {
4841 if ( $size <= 0 ) {
4842 return str_replace( '$1', $this->formatNum( $size ),
4843 $this->getMessageFromDB( str_replace( '$1', '', $messageKey ) )
4846 $sizes = [ '', 'kilo', 'mega', 'giga', 'tera', 'peta', 'exa', 'zeta', 'yotta' ];
4847 $index = 0;
4849 $maxIndex = count( $sizes ) - 1;
4850 while ( $size >= $boundary && $index < $maxIndex ) {
4851 $index++;
4852 $size /= $boundary;
4855 // For small sizes no decimal places necessary
4856 $round = 0;
4857 if ( $index > 1 ) {
4858 // For MB and bigger two decimal places are smarter
4859 $round = 2;
4861 $msg = str_replace( '$1', $sizes[$index], $messageKey );
4863 $size = round( $size, $round );
4864 $text = $this->getMessageFromDB( $msg );
4865 return str_replace( '$1', $this->formatNum( $size ), $text );
4869 * Format a size in bytes for output, using an appropriate
4870 * unit (B, KB, MB, GB, TB, PB, EB, ZB or YB) according to the magnitude in question
4872 * This method use base 1024. For base 1000 use formatBitrate(), for
4873 * another base see formatComputingNumbers()
4875 * @param int $size Size to format
4876 * @return string Plain text (not HTML)
4878 public function formatSize( $size ) {
4879 return $this->formatComputingNumbers( $size, 1024, "size-$1bytes" );
4883 * Make a list item, used by various special pages
4885 * @param string $page Page link
4886 * @param string $details HTML safe text between brackets
4887 * @param bool $oppositedm Add the direction mark opposite to your
4888 * language, to display text properly
4889 * @return string HTML escaped
4891 public function specialList( $page, $details, $oppositedm = true ) {
4892 if ( !$details ) {
4893 return $page;
4896 $dirmark = ( $oppositedm ? $this->getDirMark( true ) : '' ) . $this->getDirMark();
4897 return $page .
4898 $dirmark .
4899 $this->msg( 'word-separator' )->escaped() .
4900 $this->msg( 'parentheses' )->rawParams( $details )->escaped();
4904 * Get the conversion rule title, if any.
4906 * @deprecated since 1.35 use LanguageConverter::getConvRuleTitle instead
4908 * @return string
4910 public function getConvRuleTitle() {
4911 return $this->getConverter()->getConvRuleTitle();
4915 * Get the compiled plural rules for the language
4916 * @since 1.20
4917 * @return array Associative array with plural form, and plural rule as key-value pairs
4919 public function getCompiledPluralRules() {
4920 $pluralRules =
4921 $this->localisationCache->getItem( strtolower( $this->mCode ), 'compiledPluralRules' );
4922 if ( !$pluralRules ) {
4923 $fallbacks = $this->getFallbackLanguages();
4924 foreach ( $fallbacks as $fallbackCode ) {
4925 $pluralRules = $this->localisationCache
4926 ->getItem( strtolower( $fallbackCode ), 'compiledPluralRules' );
4927 if ( $pluralRules ) {
4928 break;
4932 return $pluralRules;
4936 * Get the plural rules for the language
4937 * @since 1.20
4938 * @return array Associative array with plural form number and plural rule as key-value pairs
4940 public function getPluralRules() {
4941 $pluralRules =
4942 $this->localisationCache->getItem( strtolower( $this->mCode ), 'pluralRules' );
4943 if ( !$pluralRules ) {
4944 $fallbacks = $this->getFallbackLanguages();
4945 foreach ( $fallbacks as $fallbackCode ) {
4946 $pluralRules = $this->localisationCache
4947 ->getItem( strtolower( $fallbackCode ), 'pluralRules' );
4948 if ( $pluralRules ) {
4949 break;
4953 return $pluralRules;
4957 * Get the plural rule types for the language
4958 * @since 1.22
4959 * @return array Associative array with plural form number and plural rule type as key-value pairs
4961 public function getPluralRuleTypes() {
4962 $pluralRuleTypes =
4963 $this->localisationCache->getItem( strtolower( $this->mCode ), 'pluralRuleTypes' );
4964 if ( !$pluralRuleTypes ) {
4965 $fallbacks = $this->getFallbackLanguages();
4966 foreach ( $fallbacks as $fallbackCode ) {
4967 $pluralRuleTypes = $this->localisationCache
4968 ->getItem( strtolower( $fallbackCode ), 'pluralRuleTypes' );
4969 if ( $pluralRuleTypes ) {
4970 break;
4974 return $pluralRuleTypes;
4978 * Find the index number of the plural rule appropriate for the given number
4979 * @param int $number
4980 * @return int The index number of the plural rule
4982 public function getPluralRuleIndexNumber( $number ) {
4983 $pluralRules = $this->getCompiledPluralRules();
4984 $form = Evaluator::evaluateCompiled( $number, $pluralRules );
4985 return $form;
4989 * Find the plural rule type appropriate for the given number
4990 * For example, if the language is set to Arabic, getPluralType(5) should
4991 * return 'few'.
4992 * @since 1.22
4993 * @param int $number
4994 * @return string The name of the plural rule type, e.g. one, two, few, many
4996 public function getPluralRuleType( $number ) {
4997 $index = $this->getPluralRuleIndexNumber( $number );
4998 $pluralRuleTypes = $this->getPluralRuleTypes();
4999 return $pluralRuleTypes[$index] ?? 'other';
5003 * Get a HookContainer, for hook metadata and running extension hooks
5005 * @since 1.35
5006 * @return HookContainer
5008 protected function getHookContainer() {
5009 return $this->hookContainer;
5013 * Get a HookRunner, for running core hooks
5015 * @internal This is for use by core only. Hook interfaces may be removed
5016 * without notice.
5017 * @since 1.35
5018 * @return HookRunner
5020 protected function getHookRunner() {
5021 return $this->hookRunner;