3 * Internationalisation code.
4 * See https://www.mediawiki.org/wiki/Special:MyLanguage/Localisation for more information.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 * http://www.gnu.org/copyleft/gpl.html
26 * @defgroup Language Language
29 use CLDRPluralRuleParser\Evaluator
;
30 use Wikimedia\Assert\Assert
;
33 * Internationalisation code
38 * Return autonyms in fetchLanguageName(s).
41 const AS_AUTONYMS
= null;
44 * Return all known languages in fetchLanguageName(s).
50 * Return in fetchLanguageName(s) only the languages for which we have at
51 * least some localisation.
54 const SUPPORTED
= 'mwfile';
57 * @var LanguageConverter
61 public $mVariants, $mCode, $mLoaded = false;
62 public $mMagicExtensions = [];
63 private $mHtmlCode = null, $mParentLanguage = false;
65 public $dateFormatStrings = [];
66 public $mExtendedSpecialPageAliases;
68 /** @var array|null */
69 protected $namespaceNames;
70 protected $mNamespaceIds, $namespaceAliases;
73 * ReplacementArray object caches
75 public $transformData = [];
78 * @var LocalisationCache
80 public static $dataCache;
82 public static $mLangObjCache = [];
85 * Return a fallback chain for messages in getFallbacksFor
88 const MESSAGES_FALLBACKS
= 0;
91 * Return a strict fallback chain in getFallbacksFor
94 const STRICT_FALLBACKS
= 1;
96 public static $mWeekdayMsgs = [
97 'sunday', 'monday', 'tuesday', 'wednesday', 'thursday',
101 public static $mWeekdayAbbrevMsgs = [
102 'sun', 'mon', 'tue', 'wed', 'thu', 'fri', 'sat'
105 public static $mMonthMsgs = [
106 'january', 'february', 'march', 'april', 'may_long', 'june',
107 'july', 'august', 'september', 'october', 'november',
110 public static $mMonthGenMsgs = [
111 'january-gen', 'february-gen', 'march-gen', 'april-gen', 'may-gen', 'june-gen',
112 'july-gen', 'august-gen', 'september-gen', 'october-gen', 'november-gen',
115 public static $mMonthAbbrevMsgs = [
116 'jan', 'feb', 'mar', 'apr', 'may', 'jun', 'jul', 'aug',
117 'sep', 'oct', 'nov', 'dec'
120 public static $mIranianCalendarMonthMsgs = [
121 'iranian-calendar-m1', 'iranian-calendar-m2', 'iranian-calendar-m3',
122 'iranian-calendar-m4', 'iranian-calendar-m5', 'iranian-calendar-m6',
123 'iranian-calendar-m7', 'iranian-calendar-m8', 'iranian-calendar-m9',
124 'iranian-calendar-m10', 'iranian-calendar-m11', 'iranian-calendar-m12'
127 public static $mHebrewCalendarMonthMsgs = [
128 'hebrew-calendar-m1', 'hebrew-calendar-m2', 'hebrew-calendar-m3',
129 'hebrew-calendar-m4', 'hebrew-calendar-m5', 'hebrew-calendar-m6',
130 'hebrew-calendar-m7', 'hebrew-calendar-m8', 'hebrew-calendar-m9',
131 'hebrew-calendar-m10', 'hebrew-calendar-m11', 'hebrew-calendar-m12',
132 'hebrew-calendar-m6a', 'hebrew-calendar-m6b'
135 public static $mHebrewCalendarMonthGenMsgs = [
136 'hebrew-calendar-m1-gen', 'hebrew-calendar-m2-gen', 'hebrew-calendar-m3-gen',
137 'hebrew-calendar-m4-gen', 'hebrew-calendar-m5-gen', 'hebrew-calendar-m6-gen',
138 'hebrew-calendar-m7-gen', 'hebrew-calendar-m8-gen', 'hebrew-calendar-m9-gen',
139 'hebrew-calendar-m10-gen', 'hebrew-calendar-m11-gen', 'hebrew-calendar-m12-gen',
140 'hebrew-calendar-m6a-gen', 'hebrew-calendar-m6b-gen'
143 public static $mHijriCalendarMonthMsgs = [
144 'hijri-calendar-m1', 'hijri-calendar-m2', 'hijri-calendar-m3',
145 'hijri-calendar-m4', 'hijri-calendar-m5', 'hijri-calendar-m6',
146 'hijri-calendar-m7', 'hijri-calendar-m8', 'hijri-calendar-m9',
147 'hijri-calendar-m10', 'hijri-calendar-m11', 'hijri-calendar-m12'
154 public static $durationIntervals = [
155 'millennia' => 31556952000,
156 'centuries' => 3155695200,
157 'decades' => 315569520,
158 'years' => 31556952, // 86400 * ( 365 + ( 24 * 3 + 25 ) / 400 )
167 * Cache for language fallbacks.
168 * @see Language::getFallbacksIncludingSiteLanguage
172 private static $fallbackLanguageCache = [];
175 * Cache for grammar rules data
176 * @var MapCacheLRU|null
178 private static $grammarTransformations;
181 * Cache for language names
182 * @var HashBagOStuff|null
184 private static $languageNameCache;
187 * Unicode directional formatting characters, for embedBidi()
189 private static $lre = "\u{202A}"; // U+202A LEFT-TO-RIGHT EMBEDDING
190 private static $rle = "\u{202B}"; // U+202B RIGHT-TO-LEFT EMBEDDING
191 private static $pdf = "\u{202C}"; // U+202C POP DIRECTIONAL FORMATTING
194 * Directionality test regex for embedBidi(). Matches the first strong directionality codepoint:
195 * - in group 1 if it is LTR
196 * - in group 2 if it is RTL
197 * Does not match if there is no strong directionality codepoint.
199 * The form is '/(?:([strong ltr codepoint])|([strong rtl codepoint]))/u' .
201 * Generated by UnicodeJS (see tools/strongDir) from the UCD; see
202 * https://phabricator.wikimedia.org/diffusion/GUJS/ .
204 // @codeCoverageIgnoreStart
205 // phpcs:ignore Generic.Files.LineLength
206 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';
207 // @codeCoverageIgnoreEnd
210 * Get a cached or new language object for a given language code
211 * @param string $code
212 * @throws MWException
215 static function factory( $code ) {
216 global $wgDummyLanguageCodes, $wgLangObjCacheSize;
218 if ( isset( $wgDummyLanguageCodes[$code] ) ) {
219 $code = $wgDummyLanguageCodes[$code];
222 // get the language object to process
223 $langObj = self
::$mLangObjCache[$code] ?? self
::newFromCode( $code );
225 // merge the language object in to get it up front in the cache
226 self
::$mLangObjCache = array_merge( [ $code => $langObj ], self
::$mLangObjCache );
227 // get rid of the oldest ones in case we have an overflow
228 self
::$mLangObjCache = array_slice( self
::$mLangObjCache, 0, $wgLangObjCacheSize, true );
234 * Create a language object for a given language code
235 * @param string $code
236 * @param bool $fallback Whether we're going through language fallback chain
237 * @throws MWException
240 protected static function newFromCode( $code, $fallback = false ) {
241 if ( !self
::isValidCode( $code ) ) {
242 throw new MWException( "Invalid language code \"$code\"" );
245 if ( !self
::isValidBuiltInCode( $code ) ) {
246 // It's not possible to customise this code with class files, so
247 // just return a Language object. This is to support uselang= hacks.
248 $lang = new Language
;
249 $lang->mCode
= $code;
253 // Check if there is a language class for the code
254 $class = self
::classFromCode( $code, $fallback );
255 // LanguageCode does not inherit Language
256 if ( class_exists( $class ) && is_a( $class, 'Language', true ) ) {
261 // Keep trying the fallback list until we find an existing class
262 $fallbacks = self
::getFallbacksFor( $code );
263 foreach ( $fallbacks as $fallbackCode ) {
264 if ( !self
::isValidBuiltInCode( $fallbackCode ) ) {
265 throw new MWException( "Invalid fallback '$fallbackCode' in fallback sequence for '$code'" );
268 $class = self
::classFromCode( $fallbackCode );
269 if ( class_exists( $class ) ) {
271 $lang->mCode
= $code;
276 throw new MWException( "Invalid fallback sequence for language '$code'" );
280 * Intended for tests that may change configuration in a way that invalidates caches.
284 public static function clearCaches() {
285 if ( !defined( 'MW_PHPUNIT_TEST' ) ) {
286 throw new MWException( __METHOD__
. ' must not be used outside tests' );
288 self
::$dataCache = null;
289 // Reinitialize $dataCache, since it's expected to always be available
290 self
::getLocalisationCache();
291 self
::$mLangObjCache = [];
292 self
::$fallbackLanguageCache = [];
293 self
::$grammarTransformations = null;
294 self
::$languageNameCache = null;
298 * Checks whether any localisation is available for that language tag
299 * in MediaWiki (MessagesXx.php exists).
301 * @param string $code Language tag (in lower case)
302 * @return bool Whether language is supported
305 public static function isSupportedLanguage( $code ) {
306 if ( !self
::isValidBuiltInCode( $code ) ) {
310 if ( $code === 'qqq' ) {
314 return is_readable( self
::getMessagesFileName( $code ) ) ||
315 is_readable( self
::getJsonMessagesFileName( $code ) );
319 * Returns true if a language code string is a well-formed language tag
320 * according to RFC 5646.
321 * This function only checks well-formedness; it doesn't check that
322 * language, script or variant codes actually exist in the repositories.
324 * Based on regexes by Mark Davis of the Unicode Consortium:
325 * https://www.unicode.org/repos/cldr/trunk/tools/java/org/unicode/cldr/util/data/langtagRegex.txt
327 * @param string $code
328 * @param bool $lenient Whether to allow '_' as separator. The default is only '-'.
333 public static function isWellFormedLanguageTag( $code, $lenient = false ) {
336 $alphanum = '[a-z0-9]';
337 $x = 'x'; # private use singleton
338 $singleton = '[a-wy-z]'; # other singleton
339 $s = $lenient ?
'[-_]' : '-';
341 $language = "$alpha{2,8}|$alpha{2,3}$s$alpha{3}";
342 $script = "$alpha{4}"; # ISO 15924
343 $region = "(?:$alpha{2}|$digit{3})"; # ISO 3166-1 alpha-2 or UN M.49
344 $variant = "(?:$alphanum{5,8}|$digit$alphanum{3})";
345 $extension = "$singleton(?:$s$alphanum{2,8})+";
346 $privateUse = "$x(?:$s$alphanum{1,8})+";
348 # Define certain grandfathered codes, since otherwise the regex is pretty useless.
349 # Since these are limited, this is safe even later changes to the registry --
350 # the only oddity is that it might change the type of the tag, and thus
351 # the results from the capturing groups.
352 # https://www.iana.org/assignments/language-subtag-registry
354 $grandfathered = "en{$s}GB{$s}oed"
355 . "|i{$s}(?:ami|bnn|default|enochian|hak|klingon|lux|mingo|navajo|pwn|tao|tay|tsu)"
356 . "|no{$s}(?:bok|nyn)"
357 . "|sgn{$s}(?:BE{$s}(?:fr|nl)|CH{$s}de)"
358 . "|zh{$s}min{$s}nan";
360 $variantList = "$variant(?:$s$variant)*";
361 $extensionList = "$extension(?:$s$extension)*";
363 $langtag = "(?:($language)"
366 . "(?:$s$variantList)?"
367 . "(?:$s$extensionList)?"
368 . "(?:$s$privateUse)?)";
370 # The final breakdown, with capturing groups for each of these components
371 # The variants, extensions, grandfathered, and private-use may have interior '-'
373 $root = "^(?:$langtag|$privateUse|$grandfathered)$";
375 return (bool)preg_match( "/$root/", strtolower( $code ) );
379 * Returns true if a language code string is of a valid form, whether or
380 * not it exists. This includes codes which are used solely for
381 * customisation via the MediaWiki namespace.
383 * @param string $code
387 public static function isValidCode( $code ) {
389 Assert
::parameterType( 'string', $code, '$code' );
390 if ( !isset( $cache[$code] ) ) {
391 // People think language codes are html safe, so enforce it.
392 // Ideally we should only allow a-zA-Z0-9-
393 // but, .+ and other chars are often used for {{int:}} hacks
394 // see bugs T39564, T39587, T38938
396 // Protect against path traversal
397 strcspn( $code, ":/\\\000&<>'\"" ) === strlen( $code )
398 && !preg_match( MediaWikiTitleCodec
::getTitleInvalidRegex(), $code );
400 return $cache[$code];
404 * Returns true if a language code is of a valid form for the purposes of
405 * internal customisation of MediaWiki, via Messages*.php or *.json.
407 * @param string $code
412 public static function isValidBuiltInCode( $code ) {
413 Assert
::parameterType( 'string', $code, '$code' );
415 return (bool)preg_match( '/^[a-z0-9-]{2,}$/', $code );
419 * Returns true if a language code is an IETF tag known to MediaWiki.
426 public static function isKnownLanguageTag( $tag ) {
427 // Quick escape for invalid input to avoid exceptions down the line
428 // when code tries to process tags which are not valid at all.
429 if ( !self
::isValidBuiltInCode( $tag ) ) {
433 if ( isset( MediaWiki\Languages\Data\Names
::$names[$tag] )
434 || self
::fetchLanguageName( $tag, $tag ) !== ''
443 * Get the LocalisationCache instance
445 * @return LocalisationCache
447 public static function getLocalisationCache() {
448 if ( is_null( self
::$dataCache ) ) {
449 global $wgLocalisationCacheConf;
450 $class = $wgLocalisationCacheConf['class'];
451 self
::$dataCache = new $class( $wgLocalisationCacheConf );
453 return self
::$dataCache;
456 function __construct() {
457 $this->mConverter
= new FakeConverter( $this );
458 // Set the code to the name of the descendant
459 if ( static::class === 'Language' ) {
462 $this->mCode
= str_replace( '_', '-', strtolower( substr( static::class, 8 ) ) );
464 self
::getLocalisationCache();
468 * Reduce memory usage
470 function __destruct() {
471 foreach ( $this as $name => $value ) {
472 unset( $this->$name );
477 * Hook which will be called if this is the content language.
478 * Descendants can use this to register hook functions or modify globals
480 function initContLang() {
487 public function getFallbackLanguages() {
488 return self
::getFallbacksFor( $this->mCode
);
492 * Exports $wgBookstoreListEn
495 public function getBookstoreList() {
496 return self
::$dataCache->getItem( $this->mCode
, 'bookstoreList' );
500 * Returns an array of localised namespaces indexed by their numbers. If the namespace is not
501 * available in localised form, it will be included in English.
503 * @return string[] List of localized namespace names, indexed by numeric namespace ID.
505 public function getNamespaces() {
506 if ( is_null( $this->namespaceNames
) ) {
507 global $wgMetaNamespace, $wgMetaNamespaceTalk, $wgExtraNamespaces;
509 $validNamespaces = MWNamespace
::getCanonicalNamespaces();
511 $this->namespaceNames
= $wgExtraNamespaces +
512 self
::$dataCache->getItem( $this->mCode
, 'namespaceNames' );
513 $this->namespaceNames +
= $validNamespaces;
515 $this->namespaceNames
[NS_PROJECT
] = $wgMetaNamespace;
516 if ( $wgMetaNamespaceTalk ) {
517 $this->namespaceNames
[NS_PROJECT_TALK
] = $wgMetaNamespaceTalk;
519 $talk = $this->namespaceNames
[NS_PROJECT_TALK
];
520 $this->namespaceNames
[NS_PROJECT_TALK
] =
521 $this->fixVariableInNamespace( $talk );
524 # Sometimes a language will be localised but not actually exist on this wiki.
525 foreach ( $this->namespaceNames
as $key => $text ) {
526 if ( !isset( $validNamespaces[$key] ) ) {
527 unset( $this->namespaceNames
[$key] );
531 # The above mixing may leave namespaces out of canonical order.
532 # Re-order by namespace ID number...
533 ksort( $this->namespaceNames
);
535 Hooks
::run( 'LanguageGetNamespaces', [ &$this->namespaceNames
] );
538 return $this->namespaceNames
;
542 * Arbitrarily set all of the namespace names at once. Mainly used for testing
543 * @param array $namespaces Array of namespaces (id => name)
545 public function setNamespaces( array $namespaces ) {
546 $this->namespaceNames
= $namespaces;
547 $this->mNamespaceIds
= null;
551 * Resets all of the namespace caches. Mainly used for testing
553 public function resetNamespaces() {
554 $this->namespaceNames
= null;
555 $this->mNamespaceIds
= null;
556 $this->namespaceAliases
= null;
560 * A convenience function that returns getNamespaces() with spaces instead of underscores
561 * in values. Useful for producing output to be displayed e.g. in `<select>` forms.
565 public function getFormattedNamespaces() {
566 $ns = $this->getNamespaces();
567 foreach ( $ns as $k => $v ) {
568 $ns[$k] = strtr( $v, '_', ' ' );
574 * Get a namespace value by key
577 * $mw_ns = $lang->getNsText( NS_MEDIAWIKI );
578 * echo $mw_ns; // prints 'MediaWiki'
581 * @param int $index The array key of the namespace to return
582 * @return string|bool String if the namespace value exists, otherwise false
584 public function getNsText( $index ) {
585 $ns = $this->getNamespaces();
586 return $ns[$index] ??
false;
590 * A convenience function that returns the same thing as
591 * getNsText() except with '_' changed to ' ', useful for
595 * $mw_ns = $lang->getFormattedNsText( NS_MEDIAWIKI_TALK );
596 * echo $mw_ns; // prints 'MediaWiki talk'
599 * @param int $index The array key of the namespace to return
600 * @return string Namespace name without underscores (empty string if namespace does not exist)
602 public function getFormattedNsText( $index ) {
603 $ns = $this->getNsText( $index );
604 return strtr( $ns, '_', ' ' );
608 * Returns gender-dependent namespace alias if available.
609 * See https://www.mediawiki.org/wiki/Manual:$wgExtraGenderNamespaces
610 * @param int $index Namespace index
611 * @param string $gender Gender key (male, female... )
615 public function getGenderNsText( $index, $gender ) {
616 global $wgExtraGenderNamespaces;
618 $ns = $wgExtraGenderNamespaces +
619 (array)self
::$dataCache->getItem( $this->mCode
, 'namespaceGenderAliases' );
621 return $ns[$index][$gender] ??
$this->getNsText( $index );
625 * Whether this language uses gender-dependent namespace aliases.
626 * See https://www.mediawiki.org/wiki/Manual:$wgExtraGenderNamespaces
630 public function needsGenderDistinction() {
631 global $wgExtraGenderNamespaces, $wgExtraNamespaces;
632 if ( count( $wgExtraGenderNamespaces ) > 0 ) {
633 // $wgExtraGenderNamespaces overrides everything
635 } elseif ( isset( $wgExtraNamespaces[NS_USER
] ) && isset( $wgExtraNamespaces[NS_USER_TALK
] ) ) {
636 /// @todo There may be other gender namespace than NS_USER & NS_USER_TALK in the future
637 // $wgExtraNamespaces overrides any gender aliases specified in i18n files
640 // Check what is in i18n files
641 $aliases = self
::$dataCache->getItem( $this->mCode
, 'namespaceGenderAliases' );
642 return count( $aliases ) > 0;
647 * Get a namespace key by value, case insensitive.
648 * Only matches namespace names for the current language, not the
649 * canonical ones defined in Namespace.php.
651 * @param string $text
652 * @return int|bool An integer if $text is a valid value otherwise false
654 function getLocalNsIndex( $text ) {
655 $lctext = $this->lc( $text );
656 $ids = $this->getNamespaceIds();
657 return $ids[$lctext] ??
false;
663 public function getNamespaceAliases() {
664 if ( is_null( $this->namespaceAliases
) ) {
665 $aliases = self
::$dataCache->getItem( $this->mCode
, 'namespaceAliases' );
669 foreach ( $aliases as $name => $index ) {
670 if ( $index === NS_PROJECT_TALK
) {
671 unset( $aliases[$name] );
672 $name = $this->fixVariableInNamespace( $name );
673 $aliases[$name] = $index;
678 global $wgExtraGenderNamespaces;
679 $genders = $wgExtraGenderNamespaces +
680 (array)self
::$dataCache->getItem( $this->mCode
, 'namespaceGenderAliases' );
681 foreach ( $genders as $index => $forms ) {
682 foreach ( $forms as $alias ) {
683 $aliases[$alias] = $index;
687 # Also add converted namespace names as aliases, to avoid confusion.
688 $convertedNames = [];
689 foreach ( $this->getVariants() as $variant ) {
690 if ( $variant === $this->mCode
) {
693 foreach ( $this->getNamespaces() as $ns => $_ ) {
694 $convertedNames[$this->getConverter()->convertNamespace( $ns, $variant )] = $ns;
698 $this->namespaceAliases
= $aliases +
$convertedNames;
700 # Filter out aliases to namespaces that don't exist, e.g. from extensions
701 # that aren't loaded here but are included in the l10n cache.
702 # (array_intersect preserves keys from its first argument)
703 $this->namespaceAliases
= array_intersect(
704 $this->namespaceAliases
,
705 array_keys( $this->getNamespaces() )
709 return $this->namespaceAliases
;
715 public function getNamespaceIds() {
716 if ( is_null( $this->mNamespaceIds
) ) {
717 global $wgNamespaceAliases;
718 # Put namespace names and aliases into a hashtable.
719 # If this is too slow, then we should arrange it so that it is done
720 # before caching. The catch is that at pre-cache time, the above
721 # class-specific fixup hasn't been done.
722 $this->mNamespaceIds
= [];
723 foreach ( $this->getNamespaces() as $index => $name ) {
724 $this->mNamespaceIds
[$this->lc( $name )] = $index;
726 foreach ( $this->getNamespaceAliases() as $name => $index ) {
727 $this->mNamespaceIds
[$this->lc( $name )] = $index;
729 if ( $wgNamespaceAliases ) {
730 foreach ( $wgNamespaceAliases as $name => $index ) {
731 $this->mNamespaceIds
[$this->lc( $name )] = $index;
735 return $this->mNamespaceIds
;
739 * Get a namespace key by value, case insensitive. Canonical namespace
740 * names override custom ones defined for the current language.
742 * @param string $text
743 * @return int|bool An integer if $text is a valid value otherwise false
745 public function getNsIndex( $text ) {
746 $lctext = $this->lc( $text );
747 $ns = MWNamespace
::getCanonicalIndex( $lctext );
748 if ( $ns !== null ) {
751 $ids = $this->getNamespaceIds();
752 return $ids[$lctext] ??
false;
756 * short names for language variants used for language conversion links.
758 * @param string $code
759 * @param bool $usemsg Use the "variantname-xyz" message if it exists
762 public function getVariantname( $code, $usemsg = true ) {
763 $msg = "variantname-$code";
764 if ( $usemsg && wfMessage( $msg )->exists() ) {
765 return $this->getMessageFromDB( $msg );
767 $name = self
::fetchLanguageName( $code );
769 return $name; # if it's defined as a language name, show that
771 # otherwise, output the language code
777 * @return string[]|bool List of date format preference keys, or false if disabled.
779 public function getDatePreferences() {
780 return self
::$dataCache->getItem( $this->mCode
, 'datePreferences' );
786 function getDateFormats() {
787 return self
::$dataCache->getItem( $this->mCode
, 'dateFormats' );
791 * @return array|string
793 public function getDefaultDateFormat() {
794 $df = self
::$dataCache->getItem( $this->mCode
, 'defaultDateFormat' );
795 if ( $df === 'dmy or mdy' ) {
796 global $wgAmericanDates;
797 return $wgAmericanDates ?
'mdy' : 'dmy';
806 public function getDatePreferenceMigrationMap() {
807 return self
::$dataCache->getItem( $this->mCode
, 'datePreferenceMigrationMap' );
813 public function getExtraUserToggles() {
814 return (array)self
::$dataCache->getItem( $this->mCode
, 'extraUserToggles' );
821 function getUserToggle( $tog ) {
822 return $this->getMessageFromDB( "tog-$tog" );
826 * Get an array of language names, indexed by code.
827 * @param null|string $inLanguage Code of language in which to return the names
828 * Use self::AS_AUTONYMS for autonyms (native names)
829 * @param string $include One of:
830 * self::ALL all available languages
831 * 'mw' only if the language is defined in MediaWiki or wgExtraLanguageNames (default)
832 * self::SUPPORTED only if the language is in 'mw' *and* has a message file
833 * @return array Language code => language name (sorted by key)
836 public static function fetchLanguageNames( $inLanguage = self
::AS_AUTONYMS
, $include = 'mw' ) {
837 $cacheKey = $inLanguage === self
::AS_AUTONYMS ?
'null' : $inLanguage;
838 $cacheKey .= ":$include";
839 if ( self
::$languageNameCache === null ) {
840 self
::$languageNameCache = new HashBagOStuff( [ 'maxKeys' => 20 ] );
843 $ret = self
::$languageNameCache->get( $cacheKey );
845 $ret = self
::fetchLanguageNamesUncached( $inLanguage, $include );
846 self
::$languageNameCache->set( $cacheKey, $ret );
852 * Uncached helper for fetchLanguageNames
853 * @param null|string $inLanguage Code of language in which to return the names
854 * Use self::AS_AUTONYMS for autonyms (native names)
855 * @param string $include One of:
856 * self::ALL all available languages
857 * 'mw' only if the language is defined in MediaWiki or wgExtraLanguageNames (default)
858 * self::SUPPORTED only if the language is in 'mw' *and* has a message file
859 * @return array Language code => language name (sorted by key)
861 private static function fetchLanguageNamesUncached(
862 $inLanguage = self
::AS_AUTONYMS
,
865 global $wgExtraLanguageNames, $wgUsePigLatinVariant;
867 // If passed an invalid language code to use, fallback to en
868 if ( $inLanguage !== self
::AS_AUTONYMS
&& !self
::isValidCode( $inLanguage ) ) {
875 # TODO: also include when $inLanguage is null, when this code is more efficient
876 Hooks
::run( 'LanguageGetTranslatedLanguageNames', [ &$names, $inLanguage ] );
879 $mwNames = $wgExtraLanguageNames + MediaWiki\Languages\Data\Names
::$names;
880 if ( $wgUsePigLatinVariant ) {
881 // Pig Latin (for variant development)
882 $mwNames['en-x-piglatin'] = 'Igpay Atinlay';
885 foreach ( $mwNames as $mwCode => $mwName ) {
886 # - Prefer own MediaWiki native name when not using the hook
887 # - For other names just add if not added through the hook
888 if ( $mwCode === $inLanguage ||
!isset( $names[$mwCode] ) ) {
889 $names[$mwCode] = $mwName;
893 if ( $include === self
::ALL
) {
899 $coreCodes = array_keys( $mwNames );
900 foreach ( $coreCodes as $coreCode ) {
901 $returnMw[$coreCode] = $names[$coreCode];
904 if ( $include === self
::SUPPORTED
) {
906 # We do this using a foreach over the codes instead of a directory
907 # loop so that messages files in extensions will work correctly.
908 foreach ( $returnMw as $code => $value ) {
909 if ( is_readable( self
::getMessagesFileName( $code ) )
910 ||
is_readable( self
::getJsonMessagesFileName( $code ) )
912 $namesMwFile[$code] = $names[$code];
916 ksort( $namesMwFile );
921 # 'mw' option; default if it's not one of the other two options (all/mwfile)
926 * @param string $code The code of the language for which to get the name
927 * @param null|string $inLanguage Code of language in which to return the name
928 * (SELF::AS_AUTONYMS for autonyms)
929 * @param string $include See fetchLanguageNames()
930 * @return string Language name or empty
933 public static function fetchLanguageName(
935 $inLanguage = self
::AS_AUTONYMS
,
938 $code = strtolower( $code );
939 $array = self
::fetchLanguageNames( $inLanguage, $include );
940 return !array_key_exists( $code, $array ) ?
'' : $array[$code];
944 * Get a message from the MediaWiki namespace.
946 * @param string $msg Message name
949 public function getMessageFromDB( $msg ) {
950 return $this->msg( $msg )->text();
954 * Get message object in this language. Only for use inside this class.
956 * @param string $msg Message name
959 protected function msg( $msg ) {
960 return wfMessage( $msg )->inLanguage( $this );
967 public function getMonthName( $key ) {
968 return $this->getMessageFromDB( self
::$mMonthMsgs[$key - 1] );
974 public function getMonthNamesArray() {
975 $monthNames = [ '' ];
976 for ( $i = 1; $i < 13; $i++
) {
977 $monthNames[] = $this->getMonthName( $i );
986 public function getMonthNameGen( $key ) {
987 return $this->getMessageFromDB( self
::$mMonthGenMsgs[$key - 1] );
994 public function getMonthAbbreviation( $key ) {
995 return $this->getMessageFromDB( self
::$mMonthAbbrevMsgs[$key - 1] );
1001 public function getMonthAbbreviationsArray() {
1002 $monthNames = [ '' ];
1003 for ( $i = 1; $i < 13; $i++
) {
1004 $monthNames[] = $this->getMonthAbbreviation( $i );
1010 * @param string $key
1013 public function getWeekdayName( $key ) {
1014 return $this->getMessageFromDB( self
::$mWeekdayMsgs[$key - 1] );
1018 * @param string $key
1021 function getWeekdayAbbreviation( $key ) {
1022 return $this->getMessageFromDB( self
::$mWeekdayAbbrevMsgs[$key - 1] );
1026 * @param string $key
1029 function getIranianCalendarMonthName( $key ) {
1030 return $this->getMessageFromDB( self
::$mIranianCalendarMonthMsgs[$key - 1] );
1034 * @param string $key
1037 function getHebrewCalendarMonthName( $key ) {
1038 return $this->getMessageFromDB( self
::$mHebrewCalendarMonthMsgs[$key - 1] );
1042 * @param string $key
1045 function getHebrewCalendarMonthNameGen( $key ) {
1046 return $this->getMessageFromDB( self
::$mHebrewCalendarMonthGenMsgs[$key - 1] );
1050 * @param string $key
1053 function getHijriCalendarMonthName( $key ) {
1054 return $this->getMessageFromDB( self
::$mHijriCalendarMonthMsgs[$key - 1] );
1058 * Pass through result from $dateTimeObj->format()
1059 * @param DateTime|bool|null &$dateTimeObj
1061 * @param DateTimeZone|bool|null $zone
1062 * @param string $code
1065 private static function dateTimeObjFormat( &$dateTimeObj, $ts, $zone, $code ) {
1066 if ( !$dateTimeObj ) {
1067 $dateTimeObj = DateTime
::createFromFormat(
1068 'YmdHis', $ts, $zone ?
: new DateTimeZone( 'UTC' )
1071 return $dateTimeObj->format( $code );
1075 * This is a workalike of PHP's date() function, but with better
1076 * internationalisation, a reduced set of format characters, and a better
1079 * Supported format characters are dDjlNwzWFmMntLoYyaAgGhHiscrUeIOPTZ. See
1080 * the PHP manual for definitions. There are a number of extensions, which
1083 * xn Do not translate digits of the next numeric format character
1084 * xN Toggle raw digit (xn) flag, stays set until explicitly unset
1085 * xr Use roman numerals for the next numeric format character
1086 * xh Use hebrew numerals for the next numeric format character
1088 * xg Genitive month name
1090 * xij j (day number) in Iranian calendar
1091 * xiF F (month name) in Iranian calendar
1092 * xin n (month number) in Iranian calendar
1093 * xiy y (two digit year) in Iranian calendar
1094 * xiY Y (full year) in Iranian calendar
1095 * xit t (days in month) in Iranian calendar
1096 * xiz z (day of the year) in Iranian calendar
1098 * xjj j (day number) in Hebrew calendar
1099 * xjF F (month name) in Hebrew calendar
1100 * xjt t (days in month) in Hebrew calendar
1101 * xjx xg (genitive month name) in Hebrew calendar
1102 * xjn n (month number) in Hebrew calendar
1103 * xjY Y (full year) in Hebrew calendar
1105 * xmj j (day number) in Hijri calendar
1106 * xmF F (month name) in Hijri calendar
1107 * xmn n (month number) in Hijri calendar
1108 * xmY Y (full year) in Hijri calendar
1110 * xkY Y (full year) in Thai solar calendar. Months and days are
1111 * identical to the Gregorian calendar
1112 * xoY Y (full year) in Minguo calendar or Juche year.
1113 * Months and days are identical to the
1114 * Gregorian calendar
1115 * xtY Y (full year) in Japanese nengo. Months and days are
1116 * identical to the Gregorian calendar
1118 * Characters enclosed in double quotes will be considered literal (with
1119 * the quotes themselves removed). Unmatched quotes will be considered
1120 * literal quotes. Example:
1122 * "The month is" F => The month is January
1125 * Backslash escaping is also supported.
1127 * Input timestamp is assumed to be pre-normalized to the desired local
1128 * time zone, if any. Note that the format characters crUeIOPTZ will assume
1129 * $ts is UTC if $zone is not given.
1131 * @param string $format
1132 * @param string $ts 14-character timestamp
1135 * @param DateTimeZone|null $zone Timezone of $ts
1136 * @param int &$ttl The amount of time (in seconds) the output may be cached for.
1137 * Only makes sense if $ts is the current time.
1138 * @todo handling of "o" format character for Iranian, Hebrew, Hijri & Thai?
1140 * @throws MWException
1143 public function sprintfDate( $format, $ts, DateTimeZone
$zone = null, &$ttl = 'unused' ) {
1148 $dateTimeObj = false;
1157 $usedSecond = false;
1158 $usedMinute = false;
1165 $usedISOYear = false;
1166 $usedIsLeapYear = false;
1168 $usedHebrewMonth = false;
1169 $usedIranianMonth = false;
1170 $usedHijriMonth = false;
1171 $usedHebrewYear = false;
1172 $usedIranianYear = false;
1173 $usedHijriYear = false;
1174 $usedTennoYear = false;
1176 if ( strlen( $ts ) !== 14 ) {
1177 throw new MWException( __METHOD__
. ": The timestamp $ts should have 14 characters" );
1180 if ( !ctype_digit( $ts ) ) {
1181 throw new MWException( __METHOD__
. ": The timestamp $ts should be a number" );
1184 $formatLength = strlen( $format );
1185 for ( $p = 0; $p < $formatLength; $p++
) {
1187 $code = $format[$p];
1188 if ( $code == 'x' && $p < $formatLength - 1 ) {
1189 $code .= $format[++
$p];
1192 if ( ( $code === 'xi'
1198 && $p < $formatLength - 1 ) {
1199 $code .= $format[++
$p];
1210 $rawToggle = !$rawToggle;
1220 $s .= $this->getMonthNameGen( substr( $ts, 4, 2 ) );
1223 $usedHebrewMonth = true;
1225 $hebrew = self
::tsToHebrew( $ts );
1227 $s .= $this->getHebrewCalendarMonthNameGen( $hebrew[1] );
1231 $num = substr( $ts, 6, 2 );
1235 $s .= $this->getWeekdayAbbreviation(
1236 self
::dateTimeObjFormat( $dateTimeObj, $ts, $zone, 'w' ) +
1
1241 $num = intval( substr( $ts, 6, 2 ) );
1246 $iranian = self
::tsToIranian( $ts );
1253 $hijri = self
::tsToHijri( $ts );
1260 $hebrew = self
::tsToHebrew( $ts );
1266 $s .= $this->getWeekdayName(
1267 self
::dateTimeObjFormat( $dateTimeObj, $ts, $zone, 'w' ) +
1
1272 $s .= $this->getMonthName( substr( $ts, 4, 2 ) );
1275 $usedIranianMonth = true;
1277 $iranian = self
::tsToIranian( $ts );
1279 $s .= $this->getIranianCalendarMonthName( $iranian[1] );
1282 $usedHijriMonth = true;
1284 $hijri = self
::tsToHijri( $ts );
1286 $s .= $this->getHijriCalendarMonthName( $hijri[1] );
1289 $usedHebrewMonth = true;
1291 $hebrew = self
::tsToHebrew( $ts );
1293 $s .= $this->getHebrewCalendarMonthName( $hebrew[1] );
1297 $num = substr( $ts, 4, 2 );
1301 $s .= $this->getMonthAbbreviation( substr( $ts, 4, 2 ) );
1305 $num = intval( substr( $ts, 4, 2 ) );
1308 $usedIranianMonth = true;
1310 $iranian = self
::tsToIranian( $ts );
1315 $usedHijriMonth = true;
1317 $hijri = self
::tsToHijri( $ts );
1322 $usedHebrewMonth = true;
1324 $hebrew = self
::tsToHebrew( $ts );
1329 $usedHebrewMonth = true;
1331 $hebrew = self
::tsToHebrew( $ts );
1337 $num = substr( $ts, 0, 4 );
1340 $usedIranianYear = true;
1342 $iranian = self
::tsToIranian( $ts );
1347 $usedHijriYear = true;
1349 $hijri = self
::tsToHijri( $ts );
1354 $usedHebrewYear = true;
1356 $hebrew = self
::tsToHebrew( $ts );
1363 $thai = self
::tsToYear( $ts, 'thai' );
1370 $minguo = self
::tsToYear( $ts, 'minguo' );
1375 $usedTennoYear = true;
1377 $tenno = self
::tsToYear( $ts, 'tenno' );
1383 $num = substr( $ts, 2, 2 );
1386 $usedIranianYear = true;
1388 $iranian = self
::tsToIranian( $ts );
1390 $num = substr( $iranian[0], -2 );
1393 $usedIranianYear = true;
1395 $iranian = self
::tsToIranian( $ts );
1397 $num = self
::$IRANIAN_DAYS[$iranian[1] - 1];
1400 $usedIranianYear = true;
1402 $iranian = self
::tsToIranian( $ts );
1408 $s .= intval( substr( $ts, 8, 2 ) ) < 12 ?
'am' : 'pm';
1412 $s .= intval( substr( $ts, 8, 2 ) ) < 12 ?
'AM' : 'PM';
1416 $h = substr( $ts, 8, 2 );
1417 $num = $h %
12 ?
: 12;
1421 $num = intval( substr( $ts, 8, 2 ) );
1425 $h = substr( $ts, 8, 2 );
1426 $num = sprintf( '%02d', $h %
12 ?
: 12 );
1430 $num = substr( $ts, 8, 2 );
1434 $num = substr( $ts, 10, 2 );
1438 $num = substr( $ts, 12, 2 );
1448 $s .= self
::dateTimeObjFormat( $dateTimeObj, $ts, $zone, $code );
1454 $num = self
::dateTimeObjFormat( $dateTimeObj, $ts, $zone, $code );
1458 $num = self
::dateTimeObjFormat( $dateTimeObj, $ts, $zone, $code );
1462 $num = self
::dateTimeObjFormat( $dateTimeObj, $ts, $zone, $code );
1465 $usedIsLeapYear = true;
1466 $num = self
::dateTimeObjFormat( $dateTimeObj, $ts, $zone, $code );
1469 $usedISOYear = true;
1470 $num = self
::dateTimeObjFormat( $dateTimeObj, $ts, $zone, $code );
1477 $num = self
::dateTimeObjFormat( $dateTimeObj, $ts, $zone, $code );
1480 # Backslash escaping
1481 if ( $p < $formatLength - 1 ) {
1482 $s .= $format[++
$p];
1489 if ( $p < $formatLength - 1 ) {
1490 $endQuote = strpos( $format, '"', $p +
1 );
1491 if ( $endQuote === false ) {
1492 # No terminating quote, assume literal "
1495 $s .= substr( $format, $p +
1, $endQuote - $p - 1 );
1499 # Quote at end of string, assume literal "
1506 if ( $num !== false ) {
1507 if ( $rawToggle ||
$raw ) {
1510 } elseif ( $roman ) {
1511 $s .= self
::romanNumeral( $num );
1513 } elseif ( $hebrewNum ) {
1514 $s .= self
::hebrewNumeral( $num );
1517 $s .= $this->formatNum( $num, true );
1522 if ( $ttl === 'unused' ) {
1523 // No need to calculate the TTL, the caller wont use it anyway.
1524 } elseif ( $usedSecond ) {
1526 } elseif ( $usedMinute ) {
1527 $ttl = 60 - substr( $ts, 12, 2 );
1528 } elseif ( $usedHour ) {
1529 $ttl = 3600 - substr( $ts, 10, 2 ) * 60 - substr( $ts, 12, 2 );
1530 } elseif ( $usedAMPM ) {
1531 $ttl = 43200 - ( substr( $ts, 8, 2 ) %
12 ) * 3600 -
1532 substr( $ts, 10, 2 ) * 60 - substr( $ts, 12, 2 );
1536 $usedIranianMonth ||
1543 // @todo Someone who understands the non-Gregorian calendars
1544 // should write proper logic for them so that they don't need purged every day.
1545 $ttl = 86400 - substr( $ts, 8, 2 ) * 3600 -
1546 substr( $ts, 10, 2 ) * 60 - substr( $ts, 12, 2 );
1549 $timeRemainingInDay = 86400 - substr( $ts, 8, 2 ) * 3600 -
1550 substr( $ts, 10, 2 ) * 60 - substr( $ts, 12, 2 );
1553 ( 7 - self
::dateTimeObjFormat( $dateTimeObj, $ts, $zone, 'N' ) ) * 86400 +
1554 $timeRemainingInDay;
1555 } elseif ( $usedISOYear ) {
1556 // December 28th falls on the last ISO week of the year, every year.
1557 // The last ISO week of a year can be 52 or 53.
1558 $lastWeekOfISOYear = DateTime
::createFromFormat(
1560 substr( $ts, 0, 4 ) . '1228',
1561 $zone ?
: new DateTimeZone( 'UTC' )
1563 $currentISOWeek = self
::dateTimeObjFormat( $dateTimeObj, $ts, $zone, 'W' );
1564 $weeksRemaining = $lastWeekOfISOYear - $currentISOWeek;
1565 $timeRemainingInWeek =
1566 ( 7 - self
::dateTimeObjFormat( $dateTimeObj, $ts, $zone, 'N' ) ) * 86400
1567 +
$timeRemainingInDay;
1568 $possibleTtls[] = $weeksRemaining * 604800 +
$timeRemainingInWeek;
1573 ( self
::dateTimeObjFormat( $dateTimeObj, $ts, $zone, 't' ) -
1574 substr( $ts, 6, 2 ) ) * 86400
1575 +
$timeRemainingInDay;
1576 } elseif ( $usedYear ) {
1578 ( self
::dateTimeObjFormat( $dateTimeObj, $ts, $zone, 'L' ) +
364 -
1579 self
::dateTimeObjFormat( $dateTimeObj, $ts, $zone, 'z' ) ) * 86400
1580 +
$timeRemainingInDay;
1581 } elseif ( $usedIsLeapYear ) {
1582 $year = substr( $ts, 0, 4 );
1583 $timeRemainingInYear =
1584 ( self
::dateTimeObjFormat( $dateTimeObj, $ts, $zone, 'L' ) +
364 -
1585 self
::dateTimeObjFormat( $dateTimeObj, $ts, $zone, 'z' ) ) * 86400
1586 +
$timeRemainingInDay;
1588 if ( $mod ||
( !( $year %
100 ) && $year %
400 ) ) {
1589 // this isn't a leap year. see when the next one starts
1590 $nextCandidate = $year - $mod +
4;
1591 if ( $nextCandidate %
100 ||
!( $nextCandidate %
400 ) ) {
1592 $possibleTtls[] = ( $nextCandidate - $year - 1 ) * 365 * 86400 +
1593 $timeRemainingInYear;
1595 $possibleTtls[] = ( $nextCandidate - $year +
3 ) * 365 * 86400 +
1596 $timeRemainingInYear;
1599 // this is a leap year, so the next year isn't
1600 $possibleTtls[] = $timeRemainingInYear;
1604 if ( $possibleTtls ) {
1605 $ttl = min( $possibleTtls );
1612 private static $GREG_DAYS = [ 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 ];
1613 private static $IRANIAN_DAYS = [ 31, 31, 31, 31, 31, 31, 30, 30, 30, 30, 30, 29 ];
1616 * Algorithm by Roozbeh Pournader and Mohammad Toossi to convert
1617 * Gregorian dates to Iranian dates. Originally written in C, it
1618 * is released under the terms of GNU Lesser General Public
1619 * License. Conversion to PHP was performed by Niklas Laxström.
1621 * Link: http://www.farsiweb.info/jalali/jalali.c
1627 private static function tsToIranian( $ts ) {
1628 $gy = substr( $ts, 0, 4 ) - 1600;
1629 $gm = substr( $ts, 4, 2 ) - 1;
1630 $gd = substr( $ts, 6, 2 ) - 1;
1632 # Days passed from the beginning (including leap years)
1634 +
floor( ( $gy +
3 ) / 4 )
1635 - floor( ( $gy +
99 ) / 100 )
1636 +
floor( ( $gy +
399 ) / 400 );
1638 // Add days of the past months of this year
1639 for ( $i = 0; $i < $gm; $i++
) {
1640 $gDayNo +
= self
::$GREG_DAYS[$i];
1644 if ( $gm > 1 && ( ( $gy %
4 === 0 && $gy %
100 !== 0 ||
( $gy %
400 == 0 ) ) ) ) {
1648 // Days passed in current month
1649 $gDayNo +
= (int)$gd;
1651 $jDayNo = $gDayNo - 79;
1653 $jNp = floor( $jDayNo / 12053 );
1656 $jy = 979 +
33 * $jNp +
4 * floor( $jDayNo / 1461 );
1659 if ( $jDayNo >= 366 ) {
1660 $jy +
= floor( ( $jDayNo - 1 ) / 365 );
1661 $jDayNo = floor( ( $jDayNo - 1 ) %
365 );
1666 for ( $i = 0; $i < 11 && $jDayNo >= self
::$IRANIAN_DAYS[$i]; $i++
) {
1667 $jDayNo -= self
::$IRANIAN_DAYS[$i];
1673 return [ $jy, $jm, $jd, $jz ];
1677 * Converting Gregorian dates to Hijri dates.
1679 * Based on a PHP-Nuke block by Sharjeel which is released under GNU/GPL license
1681 * @see https://phpnuke.org/modules.php?name=News&file=article&sid=8234&mode=thread&order=0&thold=0
1687 private static function tsToHijri( $ts ) {
1688 $year = substr( $ts, 0, 4 );
1689 $month = substr( $ts, 4, 2 );
1690 $day = substr( $ts, 6, 2 );
1698 ( $zy > 1582 ) ||
( ( $zy == 1582 ) && ( $zm > 10 ) ) ||
1699 ( ( $zy == 1582 ) && ( $zm == 10 ) && ( $zd > 14 ) )
1701 $zjd = (int)( ( 1461 * ( $zy +
4800 +
(int)( ( $zm - 14 ) / 12 ) ) ) / 4 ) +
1702 (int)( ( 367 * ( $zm - 2 - 12 * ( (int)( ( $zm - 14 ) / 12 ) ) ) ) / 12 ) -
1703 (int)( ( 3 * (int)( ( ( $zy +
4900 +
(int)( ( $zm - 14 ) / 12 ) ) / 100 ) ) ) / 4 ) +
1706 $zjd = 367 * $zy - (int)( ( 7 * ( $zy +
5001 +
(int)( ( $zm - 9 ) / 7 ) ) ) / 4 ) +
1707 (int)( ( 275 * $zm ) / 9 ) +
$zd +
1729777;
1710 $zl = $zjd - 1948440 +
10632;
1711 $zn = (int)( ( $zl - 1 ) / 10631 );
1712 $zl = $zl - 10631 * $zn +
354;
1713 $zj = ( (int)( ( 10985 - $zl ) / 5316 ) ) * ( (int)( ( 50 * $zl ) / 17719 ) ) +
1714 ( (int)( $zl / 5670 ) ) * ( (int)( ( 43 * $zl ) / 15238 ) );
1715 $zl = $zl - ( (int)( ( 30 - $zj ) / 15 ) ) * ( (int)( ( 17719 * $zj ) / 50 ) ) -
1716 ( (int)( $zj / 16 ) ) * ( (int)( ( 15238 * $zj ) / 43 ) ) +
29;
1717 $zm = (int)( ( 24 * $zl ) / 709 );
1718 $zd = $zl - (int)( ( 709 * $zm ) / 24 );
1719 $zy = 30 * $zn +
$zj - 30;
1721 return [ $zy, $zm, $zd ];
1725 * Converting Gregorian dates to Hebrew dates.
1727 * Based on a JavaScript code by Abu Mami and Yisrael Hersch
1728 * (abu-mami@kaluach.net, http://www.kaluach.net), who permitted
1729 * to translate the relevant functions into PHP and release them under
1732 * The months are counted from Tishrei = 1. In a leap year, Adar I is 13
1733 * and Adar II is 14. In a non-leap year, Adar is 6.
1739 private static function tsToHebrew( $ts ) {
1741 $year = substr( $ts, 0, 4 );
1742 $month = substr( $ts, 4, 2 );
1743 $day = substr( $ts, 6, 2 );
1745 # Calculate Hebrew year
1746 $hebrewYear = $year +
3760;
1748 # Month number when September = 1, August = 12
1750 if ( $month > 12 ) {
1757 # Calculate day of year from 1 September
1759 for ( $i = 1; $i < $month; $i++
) {
1763 # Check if the year is leap
1764 if ( $year %
400 == 0 ||
( $year %
4 == 0 && $year %
100 > 0 ) ) {
1767 } elseif ( $i == 8 ||
$i == 10 ||
$i == 1 ||
$i == 3 ) {
1774 # Calculate the start of the Hebrew year
1775 $start = self
::hebrewYearStart( $hebrewYear );
1777 # Calculate next year's start
1778 if ( $dayOfYear <= $start ) {
1779 # Day is before the start of the year - it is the previous year
1781 $nextStart = $start;
1785 # Add days since previous year's 1 September
1787 if ( ( $year %
400 == 0 ) ||
( $year %
100 != 0 && $year %
4 == 0 ) ) {
1791 # Start of the new (previous) year
1792 $start = self
::hebrewYearStart( $hebrewYear );
1795 $nextStart = self
::hebrewYearStart( $hebrewYear +
1 );
1798 # Calculate Hebrew day of year
1799 $hebrewDayOfYear = $dayOfYear - $start;
1801 # Difference between year's days
1802 $diff = $nextStart - $start;
1803 # Add 12 (or 13 for leap years) days to ignore the difference between
1804 # Hebrew and Gregorian year (353 at least vs. 365/6) - now the
1805 # difference is only about the year type
1806 if ( ( $year %
400 == 0 ) ||
( $year %
100 != 0 && $year %
4 == 0 ) ) {
1812 # Check the year pattern, and is leap year
1813 # 0 means an incomplete year, 1 means a regular year, 2 means a complete year
1814 # This is mod 30, to work on both leap years (which add 30 days of Adar I)
1815 # and non-leap years
1816 $yearPattern = $diff %
30;
1817 # Check if leap year
1818 $isLeap = $diff >= 30;
1820 # Calculate day in the month from number of day in the Hebrew year
1821 # Don't check Adar - if the day is not in Adar, we will stop before;
1822 # if it is in Adar, we will use it to check if it is Adar I or Adar II
1823 $hebrewDay = $hebrewDayOfYear;
1826 while ( $hebrewMonth <= 12 ) {
1827 # Calculate days in this month
1828 if ( $isLeap && $hebrewMonth == 6 ) {
1829 # Leap year - has Adar I, with 30 days, and Adar II, with 29 days
1831 if ( $hebrewDay <= $days ) {
1835 # Subtract the days of Adar I
1836 $hebrewDay -= $days;
1839 if ( $hebrewDay <= $days ) {
1844 } elseif ( $hebrewMonth == 2 && $yearPattern == 2 ) {
1845 # Cheshvan in a complete year (otherwise as the rule below)
1847 } elseif ( $hebrewMonth == 3 && $yearPattern == 0 ) {
1848 # Kislev in an incomplete year (otherwise as the rule below)
1851 # Odd months have 30 days, even have 29
1852 $days = 30 - ( $hebrewMonth - 1 ) %
2;
1854 if ( $hebrewDay <= $days ) {
1855 # In the current month
1858 # Subtract the days of the current month
1859 $hebrewDay -= $days;
1860 # Try in the next month
1865 return [ $hebrewYear, $hebrewMonth, $hebrewDay, $days ];
1869 * This calculates the Hebrew year start, as days since 1 September.
1870 * Based on Carl Friedrich Gauss algorithm for finding Easter date.
1871 * Used for Hebrew date.
1877 private static function hebrewYearStart( $year ) {
1878 $a = intval( ( 12 * ( $year - 1 ) +
17 ) %
19 );
1879 $b = intval( ( $year - 1 ) %
4 );
1880 $m = 32.044093161144 +
1.5542417966212 * $a +
$b / 4.0 - 0.0031777940220923 * ( $year - 1 );
1884 $Mar = intval( $m );
1890 $c = intval( ( $Mar +
3 * ( $year - 1 ) +
5 * $b +
5 ) %
7 );
1891 if ( $c == 0 && $a > 11 && $m >= 0.89772376543210 ) {
1893 } elseif ( $c == 1 && $a > 6 && $m >= 0.63287037037037 ) {
1895 } elseif ( $c == 2 ||
$c == 4 ||
$c == 6 ) {
1899 $Mar +
= intval( ( $year - 3761 ) / 100 ) - intval( ( $year - 3761 ) / 400 ) - 24;
1904 * Algorithm to convert Gregorian dates to Thai solar dates,
1905 * Minguo dates or Minguo dates.
1907 * Link: https://en.wikipedia.org/wiki/Thai_solar_calendar
1908 * https://en.wikipedia.org/wiki/Minguo_calendar
1909 * https://en.wikipedia.org/wiki/Japanese_era_name
1911 * @param string $ts 14-character timestamp
1912 * @param string $cName Calender name
1913 * @return array Converted year, month, day
1915 private static function tsToYear( $ts, $cName ) {
1916 $gy = substr( $ts, 0, 4 );
1917 $gm = substr( $ts, 4, 2 );
1918 $gd = substr( $ts, 6, 2 );
1920 if ( !strcmp( $cName, 'thai' ) ) {
1922 # Add 543 years to the Gregorian calendar
1923 # Months and days are identical
1924 $gy_offset = $gy +
543;
1925 # fix for dates between 1912 and 1941
1926 # https://en.wikipedia.org/?oldid=836596673#New_year
1927 if ( $gy >= 1912 && $gy <= 1940 ) {
1931 $gm = ( $gm - 3 ) %
12;
1933 } elseif ( ( !strcmp( $cName, 'minguo' ) ) ||
!strcmp( $cName, 'juche' ) ) {
1935 # Deduct 1911 years from the Gregorian calendar
1936 # Months and days are identical
1937 $gy_offset = $gy - 1911;
1938 } elseif ( !strcmp( $cName, 'tenno' ) ) {
1939 # Nengō dates up to Meiji period
1940 # Deduct years from the Gregorian calendar
1941 # depending on the nengo periods
1942 # Months and days are identical
1944 ||
( ( $gy == 1912 ) && ( $gm < 7 ) )
1945 ||
( ( $gy == 1912 ) && ( $gm == 7 ) && ( $gd < 31 ) )
1948 $gy_gannen = $gy - 1868 +
1;
1949 $gy_offset = $gy_gannen;
1950 if ( $gy_gannen == 1 ) {
1953 $gy_offset = '明治' . $gy_offset;
1955 ( ( $gy == 1912 ) && ( $gm == 7 ) && ( $gd == 31 ) ) ||
1956 ( ( $gy == 1912 ) && ( $gm >= 8 ) ) ||
1957 ( ( $gy > 1912 ) && ( $gy < 1926 ) ) ||
1958 ( ( $gy == 1926 ) && ( $gm < 12 ) ) ||
1959 ( ( $gy == 1926 ) && ( $gm == 12 ) && ( $gd < 26 ) )
1962 $gy_gannen = $gy - 1912 +
1;
1963 $gy_offset = $gy_gannen;
1964 if ( $gy_gannen == 1 ) {
1967 $gy_offset = '大正' . $gy_offset;
1969 ( ( $gy == 1926 ) && ( $gm == 12 ) && ( $gd >= 26 ) ) ||
1970 ( ( $gy > 1926 ) && ( $gy < 1989 ) ) ||
1971 ( ( $gy == 1989 ) && ( $gm == 1 ) && ( $gd < 8 ) )
1974 $gy_gannen = $gy - 1926 +
1;
1975 $gy_offset = $gy_gannen;
1976 if ( $gy_gannen == 1 ) {
1979 $gy_offset = '昭和' . $gy_offset;
1982 $gy_gannen = $gy - 1989 +
1;
1983 $gy_offset = $gy_gannen;
1984 if ( $gy_gannen == 1 ) {
1987 $gy_offset = '平成' . $gy_offset;
1993 return [ $gy_offset, $gm, $gd ];
1997 * Gets directionality of the first strongly directional codepoint, for embedBidi()
1999 * This is the rule the BIDI algorithm uses to determine the directionality of
2000 * paragraphs ( https://www.unicode.org/reports/tr9/#The_Paragraph_Level ) and
2001 * FSI isolates ( https://www.unicode.org/reports/tr9/#Explicit_Directional_Isolates ).
2003 * TODO: Does not handle BIDI control characters inside the text.
2004 * TODO: Does not handle unallocated characters.
2006 * @param string $text Text to test
2007 * @return null|string Directionality ('ltr' or 'rtl') or null
2009 private static function strongDirFromContent( $text = '' ) {
2010 if ( !preg_match( self
::$strongDirRegex, $text, $matches ) ) {
2013 if ( $matches[1] === '' ) {
2020 * Roman number formatting up to 10000
2026 static function romanNumeral( $num ) {
2028 [ '', 'I', 'II', 'III', 'IV', 'V', 'VI', 'VII', 'VIII', 'IX', 'X' ],
2029 [ '', 'X', 'XX', 'XXX', 'XL', 'L', 'LX', 'LXX', 'LXXX', 'XC', 'C' ],
2030 [ '', 'C', 'CC', 'CCC', 'CD', 'D', 'DC', 'DCC', 'DCCC', 'CM', 'M' ],
2031 [ '', 'M', 'MM', 'MMM', 'MMMM', 'MMMMM', 'MMMMMM', 'MMMMMMM',
2032 'MMMMMMMM', 'MMMMMMMMM', 'MMMMMMMMMM' ]
2035 $num = intval( $num );
2036 if ( $num > 10000 ||
$num <= 0 ) {
2041 for ( $pow10 = 1000, $i = 3; $i >= 0; $pow10 /= 10, $i-- ) {
2042 if ( $num >= $pow10 ) {
2043 $s .= $table[$i][(int)floor( $num / $pow10 )];
2045 $num = $num %
$pow10;
2051 * Hebrew Gematria number formatting up to 9999
2057 static function hebrewNumeral( $num ) {
2059 [ '', 'א', 'ב', 'ג', 'ד', 'ה', 'ו', 'ז', 'ח', 'ט', 'י' ],
2060 [ '', 'י', 'כ', 'ל', 'מ', 'נ', 'ס', 'ע', 'פ', 'צ', 'ק' ],
2073 [ '', 'א', 'ב', 'ג', 'ד', 'ה', 'ו', 'ז', 'ח', 'ט', 'י' ]
2076 $num = intval( $num );
2077 if ( $num > 9999 ||
$num <= 0 ) {
2081 // Round thousands have special notations
2082 if ( $num === 1000 ) {
2084 } elseif ( $num %
1000 === 0 ) {
2085 return $table[0][$num / 1000] . "' אלפים";
2090 for ( $pow10 = 1000, $i = 3; $i >= 0; $pow10 /= 10, $i-- ) {
2091 if ( $num >= $pow10 ) {
2092 if ( $num === 15 ||
$num === 16 ) {
2093 $letters[] = $table[0][9];
2094 $letters[] = $table[0][$num - 9];
2097 $letters = array_merge(
2099 (array)$table[$i][intval( $num / $pow10 )]
2102 if ( $pow10 === 1000 ) {
2108 $num = $num %
$pow10;
2111 $preTransformLength = count( $letters );
2112 if ( $preTransformLength === 1 ) {
2113 // Add geresh (single quote) to one-letter numbers
2116 $lastIndex = $preTransformLength - 1;
2117 $letters[$lastIndex] = str_replace(
2118 [ 'כ', 'מ', 'נ', 'פ', 'צ' ],
2119 [ 'ך', 'ם', 'ן', 'ף', 'ץ' ],
2120 $letters[$lastIndex]
2123 // Add gershayim (double quote) to multiple-letter numbers,
2124 // but exclude numbers with only one letter after the thousands
2125 // (1001-1009, 1020, 1030, 2001-2009, etc.)
2126 if ( $letters[1] === "'" && $preTransformLength === 3 ) {
2129 array_splice( $letters, -1, 0, '"' );
2133 return implode( $letters );
2137 * Used by date() and time() to adjust the time output.
2139 * @param string $ts The time in date('YmdHis') format
2140 * @param mixed $tz Adjust the time by this amount (default false, mean we
2141 * get user timecorrection setting)
2144 public function userAdjust( $ts, $tz = false ) {
2145 global $wgUser, $wgLocalTZoffset;
2147 if ( $tz === false ) {
2148 $tz = $wgUser->getOption( 'timecorrection' );
2151 $data = explode( '|', $tz, 3 );
2153 if ( $data[0] == 'ZoneInfo' ) {
2155 $userTZ = new DateTimeZone( $data[2] );
2156 $date = new DateTime( $ts, new DateTimeZone( 'UTC' ) );
2157 $date->setTimezone( $userTZ );
2158 return $date->format( 'YmdHis' );
2159 } catch ( Exception
$e ) {
2160 // Unrecognized timezone, default to 'Offset' with the stored offset.
2161 $data[0] = 'Offset';
2165 if ( $data[0] == 'System' ||
$tz == '' ) {
2166 # Global offset in minutes.
2167 $minDiff = $wgLocalTZoffset;
2168 } elseif ( $data[0] == 'Offset' ) {
2169 $minDiff = intval( $data[1] );
2171 $data = explode( ':', $tz );
2172 if ( count( $data ) == 2 ) {
2173 $data[0] = intval( $data[0] );
2174 $data[1] = intval( $data[1] );
2175 $minDiff = abs( $data[0] ) * 60 +
$data[1];
2176 if ( $data[0] < 0 ) {
2177 $minDiff = -$minDiff;
2180 $minDiff = intval( $data[0] ) * 60;
2184 # No difference ? Return time unchanged
2185 if ( $minDiff == 0 ) {
2189 Wikimedia\
suppressWarnings(); // E_STRICT system time bitching
2190 # Generate an adjusted date; take advantage of the fact that mktime
2191 # will normalize out-of-range values so we don't have to split $minDiff
2192 # into hours and minutes.
2194 (int)substr( $ts, 8, 2 ) ), # Hours
2195 (int)substr( $ts, 10, 2 ) +
$minDiff, # Minutes
2196 (int)substr( $ts, 12, 2 ), # Seconds
2197 (int)substr( $ts, 4, 2 ), # Month
2198 (int)substr( $ts, 6, 2 ), # Day
2199 (int)substr( $ts, 0, 4 ) ); # Year
2201 $date = date( 'YmdHis', $t );
2202 Wikimedia\restoreWarnings
();
2208 * This is meant to be used by time(), date(), and timeanddate() to get
2209 * the date preference they're supposed to use, it should be used in
2212 * function timeanddate([...], $format = true) {
2213 * $datePreference = $this->dateFormat($format);
2217 * @param int|string|bool $usePrefs If true, the user's preference is used
2218 * if false, the site/language default is used
2219 * if int/string, assumed to be a format.
2222 function dateFormat( $usePrefs = true ) {
2225 if ( is_bool( $usePrefs ) ) {
2227 $datePreference = $wgUser->getDatePreference();
2229 $datePreference = (string)User
::getDefaultOption( 'date' );
2232 $datePreference = (string)$usePrefs;
2236 if ( $datePreference == '' ) {
2240 return $datePreference;
2244 * Get a format string for a given type and preference
2245 * @param string $type May be 'date', 'time', 'both', or 'pretty'.
2246 * @param string $pref The format name as it appears in Messages*.php under
2249 * @since 1.22 New type 'pretty' that provides a more readable timestamp format
2253 function getDateFormatString( $type, $pref ) {
2254 $wasDefault = false;
2255 if ( $pref == 'default' ) {
2257 $pref = $this->getDefaultDateFormat();
2260 if ( !isset( $this->dateFormatStrings
[$type][$pref] ) ) {
2261 $df = self
::$dataCache->getSubitem( $this->mCode
, 'dateFormats', "$pref $type" );
2263 if ( $type === 'pretty' && $df === null ) {
2264 $df = $this->getDateFormatString( 'date', $pref );
2267 if ( !$wasDefault && $df === null ) {
2268 $pref = $this->getDefaultDateFormat();
2269 $df = self
::$dataCache->getSubitem( $this->mCode
, 'dateFormats', "$pref $type" );
2272 $this->dateFormatStrings
[$type][$pref] = $df;
2274 return $this->dateFormatStrings
[$type][$pref];
2278 * @param string $ts The time format which needs to be turned into a
2279 * date('YmdHis') format with wfTimestamp(TS_MW,$ts)
2280 * @param bool $adj Whether to adjust the time output according to the
2281 * user configured offset ($timecorrection)
2282 * @param mixed $format True to use user's date format preference
2283 * @param string|bool $timecorrection The time offset as returned by
2284 * validateTimeZone() in Special:Preferences
2287 public function date( $ts, $adj = false, $format = true, $timecorrection = false ) {
2288 $ts = wfTimestamp( TS_MW
, $ts );
2290 $ts = $this->userAdjust( $ts, $timecorrection );
2292 $df = $this->getDateFormatString( 'date', $this->dateFormat( $format ) );
2293 return $this->sprintfDate( $df, $ts );
2297 * @param string $ts The time format which needs to be turned into a
2298 * date('YmdHis') format with wfTimestamp(TS_MW,$ts)
2299 * @param bool $adj Whether to adjust the time output according to the
2300 * user configured offset ($timecorrection)
2301 * @param mixed $format True to use user's date format preference
2302 * @param string|bool $timecorrection The time offset as returned by
2303 * validateTimeZone() in Special:Preferences
2306 public function time( $ts, $adj = false, $format = true, $timecorrection = false ) {
2307 $ts = wfTimestamp( TS_MW
, $ts );
2309 $ts = $this->userAdjust( $ts, $timecorrection );
2311 $df = $this->getDateFormatString( 'time', $this->dateFormat( $format ) );
2312 return $this->sprintfDate( $df, $ts );
2316 * @param string $ts The time format which needs to be turned into a
2317 * date('YmdHis') format with wfTimestamp(TS_MW,$ts)
2318 * @param bool $adj Whether to adjust the time output according to the
2319 * user configured offset ($timecorrection)
2320 * @param mixed $format What format to return, if it's false output the
2321 * default one (default true)
2322 * @param string|bool $timecorrection The time offset as returned by
2323 * validateTimeZone() in Special:Preferences
2326 public function timeanddate( $ts, $adj = false, $format = true, $timecorrection = false ) {
2327 $ts = wfTimestamp( TS_MW
, $ts );
2329 $ts = $this->userAdjust( $ts, $timecorrection );
2331 $df = $this->getDateFormatString( 'both', $this->dateFormat( $format ) );
2332 return $this->sprintfDate( $df, $ts );
2336 * Takes a number of seconds and turns it into a text using values such as hours and minutes.
2340 * @param int $seconds The amount of seconds.
2341 * @param array $chosenIntervals The intervals to enable.
2345 public function formatDuration( $seconds, array $chosenIntervals = [] ) {
2346 $intervals = $this->getDurationIntervals( $seconds, $chosenIntervals );
2350 foreach ( $intervals as $intervalName => $intervalValue ) {
2351 // Messages: duration-seconds, duration-minutes, duration-hours, duration-days, duration-weeks,
2352 // duration-years, duration-decades, duration-centuries, duration-millennia
2353 $message = wfMessage( 'duration-' . $intervalName )->numParams( $intervalValue );
2354 $segments[] = $message->inLanguage( $this )->escaped();
2357 return $this->listToText( $segments );
2361 * Takes a number of seconds and returns an array with a set of corresponding intervals.
2362 * For example 65 will be turned into [ minutes => 1, seconds => 5 ].
2366 * @param int $seconds The amount of seconds.
2367 * @param array $chosenIntervals The intervals to enable.
2371 public function getDurationIntervals( $seconds, array $chosenIntervals = [] ) {
2372 if ( empty( $chosenIntervals ) ) {
2373 $chosenIntervals = [
2385 $intervals = array_intersect_key( self
::$durationIntervals, array_flip( $chosenIntervals ) );
2386 $sortedNames = array_keys( $intervals );
2387 $smallestInterval = array_pop( $sortedNames );
2391 foreach ( $intervals as $name => $length ) {
2392 $value = floor( $seconds / $length );
2394 if ( $value > 0 ||
( $name == $smallestInterval && empty( $segments ) ) ) {
2395 $seconds -= $value * $length;
2396 $segments[$name] = $value;
2404 * Internal helper function for userDate(), userTime() and userTimeAndDate()
2406 * @param string $type Can be 'date', 'time' or 'both'
2407 * @param string $ts The time format which needs to be turned into a
2408 * date('YmdHis') format with wfTimestamp(TS_MW,$ts)
2409 * @param User $user User object used to get preferences for timezone and format
2410 * @param array $options Array, can contain the following keys:
2411 * - 'timecorrection': time correction, can have the following values:
2412 * - true: use user's preference
2413 * - false: don't use time correction
2414 * - int: value of time correction in minutes
2415 * - 'format': format to use, can have the following values:
2416 * - true: use user's preference
2417 * - false: use default preference
2418 * - string: format to use
2422 private function internalUserTimeAndDate( $type, $ts, User
$user, array $options ) {
2423 $ts = wfTimestamp( TS_MW
, $ts );
2424 $options +
= [ 'timecorrection' => true, 'format' => true ];
2425 if ( $options['timecorrection'] !== false ) {
2426 if ( $options['timecorrection'] === true ) {
2427 $offset = $user->getOption( 'timecorrection' );
2429 $offset = $options['timecorrection'];
2431 $ts = $this->userAdjust( $ts, $offset );
2433 if ( $options['format'] === true ) {
2434 $format = $user->getDatePreference();
2436 $format = $options['format'];
2438 $df = $this->getDateFormatString( $type, $this->dateFormat( $format ) );
2439 return $this->sprintfDate( $df, $ts );
2443 * Get the formatted date for the given timestamp and formatted for
2446 * @param mixed $ts Mixed: the time format which needs to be turned into a
2447 * date('YmdHis') format with wfTimestamp(TS_MW,$ts)
2448 * @param User $user User object used to get preferences for timezone and format
2449 * @param array $options Array, can contain the following keys:
2450 * - 'timecorrection': time correction, can have the following values:
2451 * - true: use user's preference
2452 * - false: don't use time correction
2453 * - int: value of time correction in minutes
2454 * - 'format': format to use, can have the following values:
2455 * - true: use user's preference
2456 * - false: use default preference
2457 * - string: format to use
2461 public function userDate( $ts, User
$user, array $options = [] ) {
2462 return $this->internalUserTimeAndDate( 'date', $ts, $user, $options );
2466 * Get the formatted time for the given timestamp and formatted for
2469 * @param mixed $ts The time format which needs to be turned into a
2470 * date('YmdHis') format with wfTimestamp(TS_MW,$ts)
2471 * @param User $user User object used to get preferences for timezone and format
2472 * @param array $options Array, can contain the following keys:
2473 * - 'timecorrection': time correction, can have the following values:
2474 * - true: use user's preference
2475 * - false: don't use time correction
2476 * - int: value of time correction in minutes
2477 * - 'format': format to use, can have the following values:
2478 * - true: use user's preference
2479 * - false: use default preference
2480 * - string: format to use
2484 public function userTime( $ts, User
$user, array $options = [] ) {
2485 return $this->internalUserTimeAndDate( 'time', $ts, $user, $options );
2489 * Get the formatted date and time for the given timestamp and formatted for
2492 * @param mixed $ts The time format which needs to be turned into a
2493 * date('YmdHis') format with wfTimestamp(TS_MW,$ts)
2494 * @param User $user User object used to get preferences for timezone and format
2495 * @param array $options Array, can contain the following keys:
2496 * - 'timecorrection': time correction, can have the following values:
2497 * - true: use user's preference
2498 * - false: don't use time correction
2499 * - int: value of time correction in minutes
2500 * - 'format': format to use, can have the following values:
2501 * - true: use user's preference
2502 * - false: use default preference
2503 * - string: format to use
2507 public function userTimeAndDate( $ts, User
$user, array $options = [] ) {
2508 return $this->internalUserTimeAndDate( 'both', $ts, $user, $options );
2512 * Get the timestamp in a human-friendly relative format, e.g., "3 days ago".
2514 * Determine the difference between the timestamp and the current time, and
2515 * generate a readable timestamp by returning "<N> <units> ago", where the
2516 * largest possible unit is used.
2518 * @since 1.26 (Prior to 1.26 method existed but was not meant to be used directly)
2520 * @param MWTimestamp $time
2521 * @param MWTimestamp|null $relativeTo The base timestamp to compare to (defaults to now)
2522 * @param User|null $user User the timestamp is being generated for
2523 * (or null to use main context's user)
2524 * @return string Formatted timestamp
2526 public function getHumanTimestamp(
2527 MWTimestamp
$time, MWTimestamp
$relativeTo = null, User
$user = null
2529 if ( $relativeTo === null ) {
2530 $relativeTo = new MWTimestamp();
2532 if ( $user === null ) {
2533 $user = RequestContext
::getMain()->getUser();
2536 // Adjust for the user's timezone.
2537 $offsetThis = $time->offsetForUser( $user );
2538 $offsetRel = $relativeTo->offsetForUser( $user );
2541 if ( Hooks
::run( 'GetHumanTimestamp', [ &$ts, $time, $relativeTo, $user, $this ] ) ) {
2542 $ts = $this->getHumanTimestampInternal( $time, $relativeTo, $user );
2545 // Reset the timezone on the objects.
2546 $time->timestamp
->sub( $offsetThis );
2547 $relativeTo->timestamp
->sub( $offsetRel );
2553 * Convert an MWTimestamp into a pretty human-readable timestamp using
2554 * the given user preferences and relative base time.
2556 * @see Language::getHumanTimestamp
2557 * @param MWTimestamp $ts Timestamp to prettify
2558 * @param MWTimestamp $relativeTo Base timestamp
2559 * @param User $user User preferences to use
2560 * @return string Human timestamp
2563 private function getHumanTimestampInternal(
2564 MWTimestamp
$ts, MWTimestamp
$relativeTo, User
$user
2566 $diff = $ts->diff( $relativeTo );
2567 $diffDay = (bool)( (int)$ts->timestamp
->format( 'w' ) -
2568 (int)$relativeTo->timestamp
->format( 'w' ) );
2569 $days = $diff->days ?
: (int)$diffDay;
2570 if ( $diff->invert ||
$days > 5
2571 && $ts->timestamp
->format( 'Y' ) !== $relativeTo->timestamp
->format( 'Y' )
2573 // Timestamps are in different years: use full timestamp
2574 // Also do full timestamp for future dates
2576 * @todo FIXME: Add better handling of future timestamps.
2578 $format = $this->getDateFormatString( 'both', $user->getDatePreference() ?
: 'default' );
2579 $ts = $this->sprintfDate( $format, $ts->getTimestamp( TS_MW
) );
2580 } elseif ( $days > 5 ) {
2581 // Timestamps are in same year, but more than 5 days ago: show day and month only.
2582 $format = $this->getDateFormatString( 'pretty', $user->getDatePreference() ?
: 'default' );
2583 $ts = $this->sprintfDate( $format, $ts->getTimestamp( TS_MW
) );
2584 } elseif ( $days > 1 ) {
2585 // Timestamp within the past week: show the day of the week and time
2586 $format = $this->getDateFormatString( 'time', $user->getDatePreference() ?
: 'default' );
2587 $weekday = self
::$mWeekdayMsgs[$ts->timestamp
->format( 'w' )];
2589 // sunday-at, monday-at, tuesday-at, wednesday-at, thursday-at, friday-at, saturday-at
2590 $ts = wfMessage( "$weekday-at" )
2591 ->inLanguage( $this )
2592 ->params( $this->sprintfDate( $format, $ts->getTimestamp( TS_MW
) ) )
2594 } elseif ( $days == 1 ) {
2595 // Timestamp was yesterday: say 'yesterday' and the time.
2596 $format = $this->getDateFormatString( 'time', $user->getDatePreference() ?
: 'default' );
2597 $ts = wfMessage( 'yesterday-at' )
2598 ->inLanguage( $this )
2599 ->params( $this->sprintfDate( $format, $ts->getTimestamp( TS_MW
) ) )
2601 } elseif ( $diff->h
> 1 ||
$diff->h
== 1 && $diff->i
> 30 ) {
2602 // Timestamp was today, but more than 90 minutes ago: say 'today' and the time.
2603 $format = $this->getDateFormatString( 'time', $user->getDatePreference() ?
: 'default' );
2604 $ts = wfMessage( 'today-at' )
2605 ->inLanguage( $this )
2606 ->params( $this->sprintfDate( $format, $ts->getTimestamp( TS_MW
) ) )
2609 // From here on in, the timestamp was soon enough ago so that we can simply say
2610 // XX units ago, e.g., "2 hours ago" or "5 minutes ago"
2611 } elseif ( $diff->h
== 1 ) {
2612 // Less than 90 minutes, but more than an hour ago.
2613 $ts = wfMessage( 'hours-ago' )->inLanguage( $this )->numParams( 1 )->text();
2614 } elseif ( $diff->i
>= 1 ) {
2615 // A few minutes ago.
2616 $ts = wfMessage( 'minutes-ago' )->inLanguage( $this )->numParams( $diff->i
)->text();
2617 } elseif ( $diff->s
>= 30 ) {
2618 // Less than a minute, but more than 30 sec ago.
2619 $ts = wfMessage( 'seconds-ago' )->inLanguage( $this )->numParams( $diff->s
)->text();
2621 // Less than 30 seconds ago.
2622 $ts = wfMessage( 'just-now' )->text();
2629 * @param string $key
2630 * @return string|null
2632 public function getMessage( $key ) {
2633 return self
::$dataCache->getSubitem( $this->mCode
, 'messages', $key );
2639 function getAllMessages() {
2640 return self
::$dataCache->getItem( $this->mCode
, 'messages' );
2645 * @param string $out
2646 * @param string $string
2649 public function iconv( $in, $out, $string ) {
2650 # Even with //IGNORE iconv can whine about illegal characters in
2651 # *input* string. We just ignore those too.
2652 # REF: https://bugs.php.net/bug.php?id=37166
2653 # REF: https://phabricator.wikimedia.org/T18885
2654 Wikimedia\
suppressWarnings();
2655 $text = iconv( $in, $out . '//IGNORE', $string );
2656 Wikimedia\restoreWarnings
();
2660 // callback functions for ucwords(), ucwordbreaks()
2663 * @param array $matches
2664 * @return mixed|string
2666 function ucwordbreaksCallbackAscii( $matches ) {
2667 return $this->ucfirst( $matches[1] );
2671 * @param array $matches
2674 function ucwordbreaksCallbackMB( $matches ) {
2675 return mb_strtoupper( $matches[0] );
2679 * @param array $matches
2682 function ucwordsCallbackMB( $matches ) {
2683 return mb_strtoupper( $matches[0] );
2687 * Make a string's first character uppercase
2689 * @param string $str
2693 public function ucfirst( $str ) {
2695 if ( $o < 96 ) { // if already uppercase...
2697 } elseif ( $o < 128 ) {
2698 return ucfirst( $str ); // use PHP's ucfirst()
2700 // fall back to more complex logic in case of multibyte strings
2701 return $this->uc( $str, true );
2706 * Convert a string to uppercase
2708 * @param string $str
2709 * @param bool $first
2713 public function uc( $str, $first = false ) {
2715 if ( $this->isMultibyte( $str ) ) {
2716 return mb_strtoupper( mb_substr( $str, 0, 1 ) ) . mb_substr( $str, 1 );
2718 return ucfirst( $str );
2721 return $this->isMultibyte( $str ) ?
mb_strtoupper( $str ) : strtoupper( $str );
2726 * @param string $str
2727 * @return mixed|string
2729 function lcfirst( $str ) {
2732 return strval( $str );
2733 } elseif ( $o >= 128 ) {
2734 return $this->lc( $str, true );
2735 } elseif ( $o > 96 ) {
2738 $str[0] = strtolower( $str[0] );
2744 * @param string $str
2745 * @param bool $first
2746 * @return mixed|string
2748 function lc( $str, $first = false ) {
2750 if ( $this->isMultibyte( $str ) ) {
2751 return mb_strtolower( mb_substr( $str, 0, 1 ) ) . mb_substr( $str, 1 );
2753 return strtolower( substr( $str, 0, 1 ) ) . substr( $str, 1 );
2756 return $this->isMultibyte( $str ) ?
mb_strtolower( $str ) : strtolower( $str );
2761 * @param string $str
2764 function isMultibyte( $str ) {
2765 return strlen( $str ) !== mb_strlen( $str );
2769 * @param string $str
2770 * @return mixed|string
2772 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(
2782 [ $this, 'ucwordsCallbackMB' ],
2786 return ucwords( strtolower( $str ) );
2791 * capitalize words at word breaks
2793 * @param string $str
2796 function ucwordbreaks( $str ) {
2797 if ( $this->isMultibyte( $str ) ) {
2798 $str = $this->lc( $str );
2800 // since \b doesn't work for UTF-8, we explicitely define word break chars
2801 $breaks = "[ \-\(\)\}\{\.,\?!]";
2803 // find first letter after word break
2804 $replaceRegexp = "/^([a-z]|[\\xc0-\\xff][\\x80-\\xbf]*)|" .
2805 "$breaks([a-z]|[\\xc0-\\xff][\\x80-\\xbf]*)/";
2807 return preg_replace_callback(
2809 [ $this, 'ucwordbreaksCallbackMB' ],
2813 return preg_replace_callback(
2814 '/\b([\w\x80-\xff]+)\b/',
2815 [ $this, 'ucwordbreaksCallbackAscii' ],
2822 * Return a case-folded representation of $s
2824 * This is a representation such that caseFold($s1)==caseFold($s2) if $s1
2825 * and $s2 are the same except for the case of their characters. It is not
2826 * necessary for the value returned to make sense when displayed.
2828 * Do *not* perform any other normalisation in this function. If a caller
2829 * uses this function when it should be using a more general normalisation
2830 * function, then fix the caller.
2836 function caseFold( $s ) {
2837 return $this->uc( $s );
2841 * TODO: $s is not always a string per T218883
2845 function checkTitleEncoding( $s ) {
2846 if ( is_array( $s ) ) {
2847 throw new MWException( 'Given array to checkTitleEncoding.' );
2849 if ( StringUtils
::isUtf8( $s ) ) {
2853 return $this->iconv( $this->fallback8bitEncoding(), 'utf-8', $s );
2859 function fallback8bitEncoding() {
2860 return self
::$dataCache->getItem( $this->mCode
, 'fallback8bitEncoding' );
2864 * Most writing systems use whitespace to break up words.
2865 * Some languages such as Chinese don't conventionally do this,
2866 * which requires special handling when breaking up words for
2871 function hasWordBreaks() {
2876 * Some languages such as Chinese require word segmentation,
2877 * Specify such segmentation when overridden in derived class.
2879 * @param string $string
2882 function segmentByWord( $string ) {
2887 * Some languages have special punctuation need to be normalized.
2888 * Make such changes here.
2890 * @param string $string
2893 function normalizeForSearch( $string ) {
2894 return self
::convertDoubleWidth( $string );
2898 * convert double-width roman characters to single-width.
2899 * range: ff00-ff5f ~= 0020-007f
2901 * @param string $string
2905 protected static function convertDoubleWidth( $string ) {
2906 static $full = null;
2907 static $half = null;
2909 if ( $full === null ) {
2910 $fullWidth = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
2911 $halfWidth = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
2912 $full = str_split( $fullWidth, 3 );
2913 $half = str_split( $halfWidth );
2916 $string = str_replace( $full, $half, $string );
2921 * @param string $string
2922 * @param string $pattern
2925 protected static function insertSpace( $string, $pattern ) {
2926 $string = preg_replace( $pattern, " $1 ", $string );
2927 $string = preg_replace( '/ +/', ' ', $string );
2932 * @param array $termsArray
2935 function convertForSearchResult( $termsArray ) {
2936 # some languages, e.g. Chinese, need to do a conversion
2937 # in order for search results to be displayed correctly
2942 * Get the first character of a string.
2947 function firstChar( $s ) {
2950 '/^([\x00-\x7f]|[\xc0-\xdf][\x80-\xbf]|' .
2951 '[\xe0-\xef][\x80-\xbf]{2}|[\xf0-\xf7][\x80-\xbf]{3})/',
2956 if ( isset( $matches[1] ) ) {
2957 if ( strlen( $matches[1] ) != 3 ) {
2961 // Break down Hangul syllables to grab the first jamo
2962 $code = UtfNormal\Utils
::utf8ToCodepoint( $matches[1] );
2963 if ( $code < 0xac00 ||
0xd7a4 <= $code ) {
2965 } elseif ( $code < 0xb098 ) {
2967 } elseif ( $code < 0xb2e4 ) {
2969 } elseif ( $code < 0xb77c ) {
2971 } elseif ( $code < 0xb9c8 ) {
2973 } elseif ( $code < 0xbc14 ) {
2975 } elseif ( $code < 0xc0ac ) {
2977 } elseif ( $code < 0xc544 ) {
2979 } elseif ( $code < 0xc790 ) {
2981 } elseif ( $code < 0xcc28 ) {
2983 } elseif ( $code < 0xce74 ) {
2985 } elseif ( $code < 0xd0c0 ) {
2987 } elseif ( $code < 0xd30c ) {
2989 } elseif ( $code < 0xd558 ) {
3000 * @deprecated No-op since 1.28
3002 function initEncoding() {
3003 wfDeprecated( __METHOD__
, '1.28' );
3010 * @deprecated No-op since 1.28
3012 function recodeForEdit( $s ) {
3013 wfDeprecated( __METHOD__
, '1.28' );
3020 * @deprecated No-op since 1.28
3022 function recodeInput( $s ) {
3023 wfDeprecated( __METHOD__
, '1.28' );
3028 * Convert a UTF-8 string to normal form C. In Malayalam and Arabic, this
3029 * also cleans up certain backwards-compatible sequences, converting them
3030 * to the modern Unicode equivalent.
3032 * This is language-specific for performance reasons only.
3038 public function normalize( $s ) {
3039 global $wgAllUnicodeFixes;
3040 $s = UtfNormal\Validator
::cleanUp( $s );
3041 if ( $wgAllUnicodeFixes ) {
3042 $s = $this->transformUsingPairFile( 'normalize-ar.php', $s );
3043 $s = $this->transformUsingPairFile( 'normalize-ml.php', $s );
3050 * Transform a string using serialized data stored in the given file (which
3051 * must be in the serialized subdirectory of $IP). The file contains pairs
3052 * mapping source characters to destination characters.
3054 * The data is cached in process memory. This will go faster if you have the
3055 * FastStringSearch extension.
3057 * @param string $file
3058 * @param string $string
3060 * @throws MWException
3063 protected function transformUsingPairFile( $file, $string ) {
3064 if ( !isset( $this->transformData
[$file] ) ) {
3066 $data = require "$IP/languages/data/{$file}";
3067 $this->transformData
[$file] = new ReplacementArray( $data );
3069 return $this->transformData
[$file]->replace( $string );
3073 * For right-to-left language support
3078 return self
::$dataCache->getItem( $this->mCode
, 'rtl' );
3082 * Return the correct HTML 'dir' attribute value for this language.
3086 return $this->isRTL() ?
'rtl' : 'ltr';
3090 * Return 'left' or 'right' as appropriate alignment for line-start
3091 * for this language's text direction.
3093 * Should be equivalent to CSS3 'start' text-align value....
3097 function alignStart() {
3098 return $this->isRTL() ?
'right' : 'left';
3102 * Return 'right' or 'left' as appropriate alignment for line-end
3103 * for this language's text direction.
3105 * Should be equivalent to CSS3 'end' text-align value....
3109 function alignEnd() {
3110 return $this->isRTL() ?
'left' : 'right';
3114 * A hidden direction mark (LRM or RLM), depending on the language direction.
3115 * Unlike getDirMark(), this function returns the character as an HTML entity.
3116 * This function should be used when the output is guaranteed to be HTML,
3117 * because it makes the output HTML source code more readable. When
3118 * the output is plain text or can be escaped, getDirMark() should be used.
3120 * @param bool $opposite Get the direction mark opposite to your language
3124 function getDirMarkEntity( $opposite = false ) {
3126 return $this->isRTL() ?
'‎' : '‏';
3128 return $this->isRTL() ?
'‏' : '‎';
3132 * A hidden direction mark (LRM or RLM), depending on the language direction.
3133 * This function produces them as invisible Unicode characters and
3134 * the output may be hard to read and debug, so it should only be used
3135 * when the output is plain text or can be escaped. When the output is
3136 * HTML, use getDirMarkEntity() instead.
3138 * @param bool $opposite Get the direction mark opposite to your language
3141 function getDirMark( $opposite = false ) {
3142 $lrm = "\u{200E}"; # LEFT-TO-RIGHT MARK, commonly abbreviated LRM
3143 $rlm = "\u{200F}"; # RIGHT-TO-LEFT MARK, commonly abbreviated RLM
3145 return $this->isRTL() ?
$lrm : $rlm;
3147 return $this->isRTL() ?
$rlm : $lrm;
3153 function capitalizeAllNouns() {
3154 return self
::$dataCache->getItem( $this->mCode
, 'capitalizeAllNouns' );
3158 * An arrow, depending on the language direction.
3160 * @param string $direction The direction of the arrow: forwards (default),
3161 * backwards, left, right, up, down.
3164 function getArrow( $direction = 'forwards' ) {
3165 switch ( $direction ) {
3167 return $this->isRTL() ?
'←' : '→';
3169 return $this->isRTL() ?
'→' : '←';
3182 * To allow "foo[[bar]]" to extend the link over the whole word "foobar"
3186 function linkPrefixExtension() {
3187 return self
::$dataCache->getItem( $this->mCode
, 'linkPrefixExtension' );
3191 * Get all magic words from cache.
3194 function getMagicWords() {
3195 return self
::$dataCache->getItem( $this->mCode
, 'magicWords' );
3199 * Fill a MagicWord object with data from here
3201 * @param MagicWord $mw
3203 function getMagic( $mw ) {
3204 $rawEntry = $this->mMagicExtensions
[$mw->mId
] ??
3205 self
::$dataCache->getSubitem( $this->mCode
, 'magicWords', $mw->mId
);
3207 if ( !is_array( $rawEntry ) ) {
3208 wfWarn( "\"$rawEntry\" is not a valid magic word for \"$mw->mId\"" );
3210 $mw->mCaseSensitive
= $rawEntry[0];
3211 $mw->mSynonyms
= array_slice( $rawEntry, 1 );
3216 * Add magic words to the extension array
3218 * @param array $newWords
3220 function addMagicWordsByLang( $newWords ) {
3221 $fallbackChain = $this->getFallbackLanguages();
3222 $fallbackChain = array_reverse( $fallbackChain );
3223 foreach ( $fallbackChain as $code ) {
3224 if ( isset( $newWords[$code] ) ) {
3225 $this->mMagicExtensions
= $newWords[$code] +
$this->mMagicExtensions
;
3231 * Get special page names, as an associative array
3232 * canonical name => array of valid names, including aliases
3235 function getSpecialPageAliases() {
3236 // Cache aliases because it may be slow to load them
3237 if ( is_null( $this->mExtendedSpecialPageAliases
) ) {
3239 $this->mExtendedSpecialPageAliases
=
3240 self
::$dataCache->getItem( $this->mCode
, 'specialPageAliases' );
3243 return $this->mExtendedSpecialPageAliases
;
3247 * Italic is unsuitable for some languages
3249 * @param string $text The text to be emphasized.
3252 function emphasize( $text ) {
3253 return "<em>$text</em>";
3257 * Normally we output all numbers in plain en_US style, that is
3258 * 293,291.235 for twohundredninetythreethousand-twohundredninetyone
3259 * point twohundredthirtyfive. However this is not suitable for all
3260 * languages, some such as Bengali (bn) want ২,৯৩,২৯১.২৩৫ and others such as
3261 * Icelandic just want to use commas instead of dots, and dots instead
3262 * of commas like "293.291,235".
3264 * An example of this function being called:
3266 * wfMessage( 'message' )->numParams( $num )->text()
3269 * See $separatorTransformTable on MessageIs.php for
3270 * the , => . and . => , implementation.
3272 * @todo check if it's viable to use localeconv() for the decimal separator thing.
3273 * @param int|float $number The string to be formatted, should be an integer
3274 * or a floating point number.
3275 * @param bool $nocommafy Set to true for special numbers like dates
3278 public function formatNum( $number, $nocommafy = false ) {
3279 global $wgTranslateNumerals;
3280 if ( !$nocommafy ) {
3281 $number = $this->commafy( $number );
3282 $s = $this->separatorTransformTable();
3284 $number = strtr( $number, $s );
3288 if ( $wgTranslateNumerals ) {
3289 $s = $this->digitTransformTable();
3291 $number = strtr( $number, $s );
3295 return (string)$number;
3299 * Front-end for non-commafied formatNum
3301 * @param int|float $number The string to be formatted, should be an integer
3302 * or a floating point number.
3306 public function formatNumNoSeparators( $number ) {
3307 return $this->formatNum( $number, true );
3311 * @param string $number
3314 public function parseFormattedNumber( $number ) {
3315 $s = $this->digitTransformTable();
3317 // eliminate empty array values such as ''. (T66347)
3318 $s = array_filter( $s );
3319 $number = strtr( $number, array_flip( $s ) );
3322 $s = $this->separatorTransformTable();
3324 // eliminate empty array values such as ''. (T66347)
3325 $s = array_filter( $s );
3326 $number = strtr( $number, array_flip( $s ) );
3329 $number = strtr( $number, [ ',' => '' ] );
3334 * Adds commas to a given number
3336 * @param mixed $number
3339 function commafy( $number ) {
3340 $digitGroupingPattern = $this->digitGroupingPattern();
3341 $minimumGroupingDigits = $this->minimumGroupingDigits();
3342 if ( $number === null ) {
3346 if ( !$digitGroupingPattern ||
$digitGroupingPattern === "###,###,###" ) {
3347 // Default grouping is at thousands, use the same for ###,###,### pattern too.
3348 // In some languages it's conventional not to insert a thousands separator
3349 // in numbers that are four digits long (1000-9999).
3350 if ( $minimumGroupingDigits ) {
3351 // Number of '#' characters after last comma in the grouping pattern.
3352 // The pattern is hardcoded here, but this would vary for different patterns.
3353 $primaryGroupingSize = 3;
3354 // Maximum length of a number to suppress digit grouping for.
3355 $maximumLength = $minimumGroupingDigits +
$primaryGroupingSize - 1;
3356 if ( preg_match( '/^\-?\d{1,' . $maximumLength . '}(\.\d+)?$/', $number ) ) {
3360 return strrev( (string)preg_replace( '/(\d{3})(?=\d)(?!\d*\.)/', '$1,', strrev( $number ) ) );
3362 // Ref: http://cldr.unicode.org/translation/number-patterns
3364 if ( intval( $number ) < 0 ) {
3365 // For negative numbers apply the algorithm like positive number and add sign.
3367 $number = substr( $number, 1 );
3371 $numMatches = preg_match_all( "/(#+)/", $digitGroupingPattern, $matches );
3372 preg_match( "/\d+/", $number, $integerPart );
3373 preg_match( "/\.\d*/", $number, $decimalPart );
3374 $groupedNumber = ( count( $decimalPart ) > 0 ) ?
$decimalPart[0] : "";
3375 if ( $groupedNumber === $number ) {
3376 // the string does not have any number part. Eg: .12345
3377 return $sign . $groupedNumber;
3379 $start = $end = ( $integerPart ) ?
strlen( $integerPart[0] ) : 0;
3380 while ( $start > 0 ) {
3381 $match = $matches[0][$numMatches - 1];
3382 $matchLen = strlen( $match );
3383 $start = $end - $matchLen;
3387 $groupedNumber = substr( $number, $start, $end - $start ) . $groupedNumber;
3389 if ( $numMatches > 1 ) {
3390 // use the last pattern for the rest of the number
3394 $groupedNumber = "," . $groupedNumber;
3397 return $sign . $groupedNumber;
3404 function digitGroupingPattern() {
3405 return self
::$dataCache->getItem( $this->mCode
, 'digitGroupingPattern' );
3411 function digitTransformTable() {
3412 return self
::$dataCache->getItem( $this->mCode
, 'digitTransformTable' );
3418 function separatorTransformTable() {
3419 return self
::$dataCache->getItem( $this->mCode
, 'separatorTransformTable' );
3425 function minimumGroupingDigits() {
3426 return self
::$dataCache->getItem( $this->mCode
, 'minimumGroupingDigits' );
3430 * Take a list of strings and build a locale-friendly comma-separated
3431 * list, using the local comma-separator message.
3432 * The last two strings are chained with an "and".
3434 * @param string[] $list
3437 public function listToText( array $list ) {
3438 $itemCount = count( $list );
3439 if ( $itemCount < 1 ) {
3442 $text = array_pop( $list );
3443 if ( $itemCount > 1 ) {
3444 $and = $this->msg( 'and' )->escaped();
3445 $space = $this->msg( 'word-separator' )->escaped();
3447 if ( $itemCount > 2 ) {
3448 $comma = $this->msg( 'comma-separator' )->escaped();
3450 $text = implode( $comma, $list ) . $and . $space . $text;
3456 * Take a list of strings and build a locale-friendly comma-separated
3457 * list, using the local comma-separator message.
3458 * @param string[] $list Array of strings to put in a comma list
3461 function commaList( array $list ) {
3463 wfMessage( 'comma-separator' )->inLanguage( $this )->escaped(),
3469 * Take a list of strings and build a locale-friendly semicolon-separated
3470 * list, using the local semicolon-separator message.
3471 * @param string[] $list Array of strings to put in a semicolon list
3474 function semicolonList( array $list ) {
3476 wfMessage( 'semicolon-separator' )->inLanguage( $this )->escaped(),
3482 * Same as commaList, but separate it with the pipe instead.
3483 * @param string[] $list Array of strings to put in a pipe list
3486 function pipeList( array $list ) {
3488 wfMessage( 'pipe-separator' )->inLanguage( $this )->escaped(),
3494 * Truncate a string to a specified length in bytes, appending an optional
3495 * string (e.g. for ellipsis)
3497 * If $length is negative, the string will be truncated from the beginning
3501 * @param string $string String to truncate
3502 * @param int $length Maximum length in bytes
3503 * @param string $ellipsis String to append to the end of truncated text
3504 * @param bool $adjustLength Subtract length of ellipsis from $length
3508 function truncateForDatabase( $string, $length, $ellipsis = '...', $adjustLength = true ) {
3509 return $this->truncateInternal(
3510 $string, $length, $ellipsis, $adjustLength, 'strlen', 'substr'
3515 * Truncate a string to a specified number of characters, appending an optional
3516 * string (e.g. for ellipsis).
3518 * This provides multibyte version of truncateForDatabase() method of this class,
3519 * suitable for truncation based on number of characters, instead of number of bytes.
3521 * If $length is negative, the string will be truncated from the beginning.
3525 * @param string $string String to truncate
3526 * @param int $length Maximum number of characters
3527 * @param string $ellipsis String to append to the end of truncated text
3528 * @param bool $adjustLength Subtract length of ellipsis from $length
3532 function truncateForVisual( $string, $length, $ellipsis = '...', $adjustLength = true ) {
3533 // Passing encoding to mb_strlen and mb_substr is optional.
3534 // Encoding defaults to mb_internal_encoding(), which is set to UTF-8 in Setup.php, so
3535 // explicit specification of encoding is skipped.
3536 // Note: Both multibyte methods are callables invoked in truncateInternal.
3537 return $this->truncateInternal(
3538 $string, $length, $ellipsis, $adjustLength, 'mb_strlen', 'mb_substr'
3543 * Internal method used for truncation. This method abstracts text truncation into
3544 * one common method, allowing users to provide length measurement function and
3545 * function for finding substring.
3547 * For usages, see truncateForDatabase and truncateForVisual.
3549 * @param string $string String to truncate
3550 * @param int $length Maximum length of final text
3551 * @param string $ellipsis String to append to the end of truncated text
3552 * @param bool $adjustLength Subtract length of ellipsis from $length
3553 * @param callable $measureLength Callable function used for determining the length of text
3554 * @param callable $getSubstring Callable function used for getting the substrings
3558 private function truncateInternal(
3559 $string, $length, $ellipsis, $adjustLength, callable
$measureLength, callable
$getSubstring
3561 # Check if there is no need to truncate
3562 if ( $measureLength( $string ) <= abs( $length ) ) {
3563 return $string; // no need to truncate
3566 # Use the localized ellipsis character
3567 if ( $ellipsis == '...' ) {
3568 $ellipsis = wfMessage( 'ellipsis' )->inLanguage( $this )->escaped();
3570 if ( $length == 0 ) {
3571 return $ellipsis; // convention
3574 $stringOriginal = $string;
3575 # If ellipsis length is >= $length then we can't apply $adjustLength
3576 if ( $adjustLength && $measureLength( $ellipsis ) >= abs( $length ) ) {
3577 $string = $ellipsis; // this can be slightly unexpected
3578 # Otherwise, truncate and add ellipsis...
3580 $ellipsisLength = $adjustLength ?
$measureLength( $ellipsis ) : 0;
3581 if ( $length > 0 ) {
3582 $length -= $ellipsisLength;
3583 $string = $getSubstring( $string, 0, $length ); // xyz...
3584 $string = $this->removeBadCharLast( $string );
3585 $string = rtrim( $string ) . $ellipsis;
3587 $length +
= $ellipsisLength;
3588 $string = $getSubstring( $string, $length ); // ...xyz
3589 $string = $this->removeBadCharFirst( $string );
3590 $string = $ellipsis . ltrim( $string );
3594 # Do not truncate if the ellipsis makes the string longer/equal (T24181).
3595 # This check is *not* redundant if $adjustLength, due to the single case where
3596 # LEN($ellipsis) > ABS($limit arg); $stringOriginal could be shorter than $string.
3597 if ( $measureLength( $string ) < $measureLength( $stringOriginal ) ) {
3600 return $stringOriginal;
3605 * Remove bytes that represent an incomplete Unicode character
3606 * at the end of string (e.g. bytes of the char are missing)
3608 * @param string $string
3611 protected function removeBadCharLast( $string ) {
3612 if ( $string != '' ) {
3613 $char = ord( $string[strlen( $string ) - 1] );
3615 if ( $char >= 0xc0 ) {
3616 # We got the first byte only of a multibyte char; remove it.
3617 $string = substr( $string, 0, -1 );
3618 } elseif ( $char >= 0x80 &&
3619 // Use the /s modifier (PCRE_DOTALL) so (.*) also matches newlines
3620 preg_match( '/^(.*)(?:[\xe0-\xef][\x80-\xbf]|' .
3621 '[\xf0-\xf7][\x80-\xbf]{1,2})$/s', $string, $m )
3623 # We chopped in the middle of a character; remove it
3631 * Remove bytes that represent an incomplete Unicode character
3632 * at the start of string (e.g. bytes of the char are missing)
3634 * @param string $string
3637 protected function removeBadCharFirst( $string ) {
3638 if ( $string != '' ) {
3639 $char = ord( $string[0] );
3640 if ( $char >= 0x80 && $char < 0xc0 ) {
3641 # We chopped in the middle of a character; remove the whole thing
3642 $string = preg_replace( '/^[\x80-\xbf]+/', '', $string );
3649 * Truncate a string of valid HTML to a specified length in bytes,
3650 * appending an optional string (e.g. for ellipses), and return valid HTML
3652 * This is only intended for styled/linked text, such as HTML with
3653 * tags like <span> and <a>, were the tags are self-contained (valid HTML).
3654 * Also, this will not detect things like "display:none" CSS.
3656 * Note: since 1.18 you do not need to leave extra room in $length for ellipses.
3658 * @param string $text HTML string to truncate
3659 * @param int $length (zero/positive) Maximum length (including ellipses)
3660 * @param string $ellipsis String to append to the truncated text
3663 function truncateHtml( $text, $length, $ellipsis = '...' ) {
3664 # Use the localized ellipsis character
3665 if ( $ellipsis == '...' ) {
3666 $ellipsis = wfMessage( 'ellipsis' )->inLanguage( $this )->escaped();
3668 # Check if there is clearly no need to truncate
3669 if ( $length <= 0 ) {
3670 return $ellipsis; // no text shown, nothing to format (convention)
3671 } elseif ( strlen( $text ) <= $length ) {
3672 return $text; // string short enough even *with* HTML (short-circuit)
3675 $dispLen = 0; // innerHTML legth so far
3676 $testingEllipsis = false; // checking if ellipses will make string longer/equal?
3677 $tagType = 0; // 0-open, 1-close
3678 $bracketState = 0; // 1-tag start, 2-tag name, 0-neither
3679 $entityState = 0; // 0-not entity, 1-entity
3680 $tag = $ret = ''; // accumulated tag name, accumulated result string
3681 $openTags = []; // open tag stack
3682 $maybeState = null; // possible truncation state
3684 $textLen = strlen( $text );
3685 $neLength = max( 0, $length - strlen( $ellipsis ) ); // non-ellipsis len if truncated
3686 for ( $pos = 0; true; ++
$pos ) {
3687 # Consider truncation once the display length has reached the maximim.
3688 # We check if $dispLen > 0 to grab tags for the $neLength = 0 case.
3689 # Check that we're not in the middle of a bracket/entity...
3690 if ( $dispLen && $dispLen >= $neLength && $bracketState == 0 && !$entityState ) {
3691 if ( !$testingEllipsis ) {
3692 $testingEllipsis = true;
3693 # Save where we are; we will truncate here unless there turn out to
3694 # be so few remaining characters that truncation is not necessary.
3695 if ( !$maybeState ) { // already saved? ($neLength = 0 case)
3696 $maybeState = [ $ret, $openTags ]; // save state
3698 } elseif ( $dispLen > $length && $dispLen > strlen( $ellipsis ) ) {
3699 # String in fact does need truncation, the truncation point was OK.
3700 list( $ret, $openTags ) = $maybeState; // reload state
3701 $ret = $this->removeBadCharLast( $ret ); // multi-byte char fix
3702 $ret .= $ellipsis; // add ellipsis
3706 if ( $pos >= $textLen ) {
3707 break; // extra iteration just for above checks
3710 # Read the next char...
3712 $lastCh = $pos ?
$text[$pos - 1] : '';
3713 $ret .= $ch; // add to result string
3715 $this->truncate_endBracket( $tag, $tagType, $lastCh, $openTags ); // for bad HTML
3716 $entityState = 0; // for bad HTML
3717 $bracketState = 1; // tag started (checking for backslash)
3718 } elseif ( $ch == '>' ) {
3719 $this->truncate_endBracket( $tag, $tagType, $lastCh, $openTags );
3720 $entityState = 0; // for bad HTML
3721 $bracketState = 0; // out of brackets
3722 } elseif ( $bracketState == 1 ) {
3724 $tagType = 1; // close tag (e.g. "</span>")
3726 $tagType = 0; // open tag (e.g. "<span>")
3729 $bracketState = 2; // building tag name
3730 } elseif ( $bracketState == 2 ) {
3734 // Name found (e.g. "<a href=..."), add on tag attributes...
3735 $pos +
= $this->truncate_skip( $ret, $text, "<>", $pos +
1 );
3737 } elseif ( $bracketState == 0 ) {
3738 if ( $entityState ) {
3741 $dispLen++
; // entity is one displayed char
3744 if ( $neLength == 0 && !$maybeState ) {
3745 // Save state without $ch. We want to *hit* the first
3746 // display char (to get tags) but not *use* it if truncating.
3747 $maybeState = [ substr( $ret, 0, -1 ), $openTags ];
3750 $entityState = 1; // entity found, (e.g. " ")
3752 $dispLen++
; // this char is displayed
3753 // Add the next $max display text chars after this in one swoop...
3754 $max = ( $testingEllipsis ?
$length : $neLength ) - $dispLen;
3755 $skipped = $this->truncate_skip( $ret, $text, "<>&", $pos +
1, $max );
3756 $dispLen +
= $skipped;
3762 // Close the last tag if left unclosed by bad HTML
3763 $this->truncate_endBracket( $tag, $text[$textLen - 1], $tagType, $openTags );
3764 while ( count( $openTags ) > 0 ) {
3765 $ret .= '</' . array_pop( $openTags ) . '>'; // close open tags
3771 * truncateHtml() helper function
3772 * like strcspn() but adds the skipped chars to $ret
3774 * @param string $ret
3775 * @param string $text
3776 * @param string $search
3778 * @param null|int $len
3781 private function truncate_skip( &$ret, $text, $search, $start, $len = null ) {
3782 if ( $len === null ) {
3783 $len = -1; // -1 means "no limit" for strcspn
3784 } elseif ( $len < 0 ) {
3788 if ( $start < strlen( $text ) ) {
3789 $skipCount = strcspn( $text, $search, $start, $len );
3790 $ret .= substr( $text, $start, $skipCount );
3796 * truncateHtml() helper function
3797 * (a) push or pop $tag from $openTags as needed
3798 * (b) clear $tag value
3799 * @param string &$tag Current HTML tag name we are looking at
3800 * @param int $tagType (0-open tag, 1-close tag)
3801 * @param string $lastCh Character before the '>' that ended this tag
3802 * @param array &$openTags Open tag stack (not accounting for $tag)
3804 private function truncate_endBracket( &$tag, $tagType, $lastCh, &$openTags ) {
3805 $tag = ltrim( $tag );
3807 if ( $tagType == 0 && $lastCh != '/' ) {
3808 $openTags[] = $tag; // tag opened (didn't close itself)
3809 } elseif ( $tagType == 1 ) {
3810 if ( $openTags && $tag == $openTags[count( $openTags ) - 1] ) {
3811 array_pop( $openTags ); // tag closed
3819 * Grammatical transformations, needed for inflected languages
3820 * Invoked by putting {{grammar:case|word}} in a message
3822 * @param string $word
3823 * @param string $case
3826 function convertGrammar( $word, $case ) {
3827 global $wgGrammarForms;
3828 if ( isset( $wgGrammarForms[$this->getCode()][$case][$word] ) ) {
3829 return $wgGrammarForms[$this->getCode()][$case][$word];
3832 $grammarTransformations = $this->getGrammarTransformations();
3834 if ( isset( $grammarTransformations[$case] ) ) {
3835 $forms = $grammarTransformations[$case];
3837 // Some names of grammar rules are aliases for other rules.
3838 // In such cases the value is a string rather than object,
3839 // so load the actual rules.
3840 if ( is_string( $forms ) ) {
3841 $forms = $grammarTransformations[$forms];
3844 foreach ( array_values( $forms ) as $rule ) {
3847 if ( $form === '@metadata' ) {
3851 $replacement = $rule[1];
3853 $regex = '/' . addcslashes( $form, '/' ) . '/u';
3854 $patternMatches = preg_match( $regex, $word );
3856 if ( $patternMatches === false ) {
3858 'An error occurred while processing grammar. ' .
3859 "Word: '$word'. Regex: /$form/."
3861 } elseif ( $patternMatches === 1 ) {
3862 $word = preg_replace( $regex, $replacement, $word );
3873 * Get the grammar forms for the content language
3874 * @return array Array of grammar forms
3877 function getGrammarForms() {
3878 global $wgGrammarForms;
3879 if ( isset( $wgGrammarForms[$this->getCode()] )
3880 && is_array( $wgGrammarForms[$this->getCode()] )
3882 return $wgGrammarForms[$this->getCode()];
3889 * Get the grammar transformations data for the language.
3890 * Used like grammar forms, with {{GRAMMAR}} and cases,
3891 * but uses pairs of regexes and replacements instead of code.
3893 * @return array[] Array of grammar transformations.
3894 * @throws MWException
3897 public function getGrammarTransformations() {
3898 $languageCode = $this->getCode();
3900 if ( self
::$grammarTransformations === null ) {
3901 self
::$grammarTransformations = new MapCacheLRU( 10 );
3904 if ( self
::$grammarTransformations->has( $languageCode ) ) {
3905 return self
::$grammarTransformations->get( $languageCode );
3910 $grammarDataFile = __DIR__
. "/data/grammarTransformations/$languageCode.json";
3911 if ( is_readable( $grammarDataFile ) ) {
3912 $data = FormatJson
::decode(
3913 file_get_contents( $grammarDataFile ),
3917 if ( $data === null ) {
3918 throw new MWException( "Invalid grammar data for \"$languageCode\"." );
3921 self
::$grammarTransformations->set( $languageCode, $data );
3928 * Provides an alternative text depending on specified gender.
3929 * Usage {{gender:username|masculine|feminine|unknown}}.
3930 * username is optional, in which case the gender of current user is used,
3931 * but only in (some) interface messages; otherwise default gender is used.
3933 * If no forms are given, an empty string is returned. If only one form is
3934 * given, it will be returned unconditionally. These details are implied by
3935 * the caller and cannot be overridden in subclasses.
3937 * If three forms are given, the default is to use the third (unknown) form.
3938 * If fewer than three forms are given, the default is to use the first (masculine) form.
3939 * These details can be overridden in subclasses.
3941 * @param string $gender
3942 * @param array $forms
3946 function gender( $gender, $forms ) {
3947 if ( !count( $forms ) ) {
3950 $forms = $this->preConvertPlural( $forms, 2 );
3951 if ( $gender === 'male' ) {
3954 if ( $gender === 'female' ) {
3957 return $forms[2] ??
$forms[0];
3961 * Plural form transformations, needed for some languages.
3962 * For example, there are 3 form of plural in Russian and Polish,
3963 * depending on "count mod 10". See [[w:Plural]]
3964 * For English it is pretty simple.
3966 * Invoked by putting {{plural:count|wordform1|wordform2}}
3967 * or {{plural:count|wordform1|wordform2|wordform3}}
3969 * Example: {{plural:{{NUMBEROFARTICLES}}|article|articles}}
3971 * @param int $count Non-localized number
3972 * @param array $forms Different plural forms
3973 * @return string Correct form of plural for $count in this language
3975 function convertPlural( $count, $forms ) {
3976 // Handle explicit n=pluralform cases
3977 $forms = $this->handleExplicitPluralForms( $count, $forms );
3978 if ( is_string( $forms ) ) {
3981 if ( !count( $forms ) ) {
3985 $pluralForm = $this->getPluralRuleIndexNumber( $count );
3986 $pluralForm = min( $pluralForm, count( $forms ) - 1 );
3987 return $forms[$pluralForm];
3991 * Handles explicit plural forms for Language::convertPlural()
3993 * In {{PLURAL:$1|0=nothing|one|many}}, 0=nothing will be returned if $1 equals zero.
3994 * If an explicitly defined plural form matches the $count, then
3995 * string value returned, otherwise array returned for further consideration
3996 * by CLDR rules or overridden convertPlural().
4000 * @param int $count Non-localized number
4001 * @param array $forms Different plural forms
4003 * @return array|string
4005 protected function handleExplicitPluralForms( $count, array $forms ) {
4006 foreach ( $forms as $index => $form ) {
4007 if ( preg_match( '/\d+=/i', $form ) ) {
4008 $pos = strpos( $form, '=' );
4009 if ( substr( $form, 0, $pos ) === (string)$count ) {
4010 return substr( $form, $pos +
1 );
4012 unset( $forms[$index] );
4015 return array_values( $forms );
4019 * Checks that convertPlural was given an array and pads it to requested
4020 * amount of forms by copying the last one.
4022 * @param array $forms
4023 * @param int $count How many forms should there be at least
4024 * @return array Padded array of forms
4026 protected function preConvertPlural( /* Array */ $forms, $count ) {
4027 return array_pad( $forms, $count, end( $forms ) );
4031 * Wraps argument with unicode control characters for directionality safety
4033 * This solves the problem where directionality-neutral characters at the edge of
4034 * the argument string get interpreted with the wrong directionality from the
4035 * enclosing context, giving renderings that look corrupted like "(Ben_(WMF".
4037 * The wrapping is LRE...PDF or RLE...PDF, depending on the detected
4038 * directionality of the argument string, using the BIDI algorithm's own "First
4039 * strong directional codepoint" rule. Essentially, this works round the fact that
4040 * there is no embedding equivalent of U+2068 FSI (isolation with heuristic
4041 * direction inference). The latter is cleaner but still not widely supported.
4043 * @param string $text Text to wrap
4044 * @return string Text, wrapped in LRE...PDF or RLE...PDF or nothing
4046 public function embedBidi( $text = '' ) {
4047 $dir = self
::strongDirFromContent( $text );
4048 if ( $dir === 'ltr' ) {
4049 // Wrap in LEFT-TO-RIGHT EMBEDDING ... POP DIRECTIONAL FORMATTING
4050 return self
::$lre . $text . self
::$pdf;
4052 if ( $dir === 'rtl' ) {
4053 // Wrap in RIGHT-TO-LEFT EMBEDDING ... POP DIRECTIONAL FORMATTING
4054 return self
::$rle . $text . self
::$pdf;
4056 // No strong directionality: do not wrap
4061 * @todo Maybe translate block durations. Note that this function is somewhat misnamed: it
4062 * deals with translating the *duration* ("1 week", "4 days", etc), not the expiry time
4063 * (which is an absolute timestamp). Please note: do NOT add this blindly, as it is used
4064 * on old expiry lengths recorded in log entries. You'd need to provide the start date to
4067 * @param string $str The validated block duration in English
4068 * @param User|null $user User object to use timezone from or null for $wgUser
4069 * @param int $now Current timestamp, for formatting relative block durations
4070 * @return string Somehow translated block duration
4071 * @see LanguageFi.php for example implementation
4073 function translateBlockExpiry( $str, User
$user = null, $now = 0 ) {
4074 $duration = SpecialBlock
::getSuggestedDurations( $this );
4075 foreach ( $duration as $show => $value ) {
4076 if ( strcmp( $str, $value ) == 0 ) {
4077 return htmlspecialchars( trim( $show ) );
4081 if ( wfIsInfinity( $str ) ) {
4082 foreach ( $duration as $show => $value ) {
4083 if ( wfIsInfinity( $value ) ) {
4084 return htmlspecialchars( trim( $show ) );
4089 // If all else fails, return a standard duration or timestamp description.
4090 $time = strtotime( $str, $now );
4091 if ( $time === false ) { // Unknown format. Return it as-is in case.
4093 } elseif ( $time !== strtotime( $str, $now +
1 ) ) { // It's a relative timestamp.
4094 // The result differs based on current time, so the difference
4095 // is a fixed duration length.
4096 return $this->formatDuration( $time - $now );
4097 } else { // It's an absolute timestamp.
4098 if ( $time === 0 ) {
4099 // wfTimestamp() handles 0 as current time instead of epoch.
4100 $time = '19700101000000';
4103 return $this->userTimeAndDate( $time, $user );
4105 return $this->timeanddate( $time );
4110 * languages like Chinese need to be segmented in order for the diff
4113 * @param string $text
4116 public function segmentForDiff( $text ) {
4121 * and unsegment to show the result
4123 * @param string $text
4126 public function unsegmentForDiff( $text ) {
4131 * Return the LanguageConverter used in the Language
4134 * @return LanguageConverter
4136 public function getConverter() {
4137 return $this->mConverter
;
4141 * convert text to a variant
4143 * @param string $text text to convert
4144 * @param string|bool $variant variant to convert to, or false to use the user's preferred
4145 * variant (if logged in), or the project default variant
4146 * @return string the converted string
4148 public function autoConvert( $text, $variant = false ) {
4149 return $this->mConverter
->autoConvert( $text, $variant );
4153 * convert text to all supported variants
4155 * @param string $text
4158 public function autoConvertToAllVariants( $text ) {
4159 return $this->mConverter
->autoConvertToAllVariants( $text );
4163 * convert text to different variants of a language.
4165 * @warning Glossary state is maintained between calls. This means
4166 * if you pass unescaped text to this method it can cause an XSS
4167 * in later calls to this method, even if the later calls have properly
4168 * escaped the input. Never feed this method user controlled text that
4169 * is not properly escaped!
4170 * @param string $text Content that has been already escaped for use in HTML
4171 * @return string HTML
4173 public function convert( $text ) {
4174 return $this->mConverter
->convert( $text );
4178 * Convert a Title object to a string in the preferred variant
4180 * @param Title $title
4183 public function convertTitle( $title ) {
4184 return $this->mConverter
->convertTitle( $title );
4188 * Convert a namespace index to a string in the preferred variant
4190 * @param int $ns namespace index (https://www.mediawiki.org/wiki/Manual:Namespace)
4191 * @param string|null $variant variant to convert to, or null to use the user's preferred
4192 * variant (if logged in), or the project default variant
4193 * @return string a string representation of the namespace
4195 public function convertNamespace( $ns, $variant = null ) {
4196 return $this->mConverter
->convertNamespace( $ns, $variant );
4200 * Check if this is a language with variants
4204 public function hasVariants() {
4205 return count( $this->getVariants() ) > 1;
4209 * Strict check if the language has the specific variant.
4211 * Compare to LanguageConverter::validateVariant() which does a more
4212 * lenient check and attempts to coerce the given code to a valid one.
4215 * @param string $variant
4218 public function hasVariant( $variant ) {
4219 return $variant && ( $variant === $this->mConverter
->validateVariant( $variant ) );
4223 * Perform output conversion on a string, and encode for safe HTML output.
4224 * @param string $text Text to be converted
4226 * @todo this should get integrated somewhere sane
4228 public function convertHtml( $text ) {
4229 return htmlspecialchars( $this->convert( $text ) );
4233 * @param string $key
4236 public function convertCategoryKey( $key ) {
4237 return $this->mConverter
->convertCategoryKey( $key );
4241 * Get the list of variants supported by this language
4242 * see sample implementation in LanguageZh.php
4244 * @return string[] An array of language codes
4246 public function getVariants() {
4247 return $this->mConverter
->getVariants();
4253 public function getPreferredVariant() {
4254 return $this->mConverter
->getPreferredVariant();
4260 public function getDefaultVariant() {
4261 return $this->mConverter
->getDefaultVariant();
4267 public function getURLVariant() {
4268 return $this->mConverter
->getURLVariant();
4272 * If a language supports multiple variants, it is
4273 * possible that non-existing link in one variant
4274 * actually exists in another variant. this function
4275 * tries to find it. See e.g. LanguageZh.php
4276 * The input parameters may be modified upon return
4278 * @param string &$link The name of the link
4279 * @param Title &$nt The title object of the link
4280 * @param bool $ignoreOtherCond To disable other conditions when
4281 * we need to transclude a template or update a category's link
4283 public function findVariantLink( &$link, &$nt, $ignoreOtherCond = false ) {
4284 $this->mConverter
->findVariantLink( $link, $nt, $ignoreOtherCond );
4288 * returns language specific options used by User::getPageRenderHash()
4289 * for example, the preferred language variant
4293 function getExtraHashOptions() {
4294 return $this->mConverter
->getExtraHashOptions();
4298 * For languages that support multiple variants, the title of an
4299 * article may be displayed differently in different variants. this
4300 * function returns the apporiate title defined in the body of the article.
4304 public function getParsedTitle() {
4305 return $this->mConverter
->getParsedTitle();
4309 * Refresh the cache of conversion tables when
4310 * MediaWiki:Conversiontable* is updated.
4312 * @param Title $title The Title of the page being updated
4314 public function updateConversionTable( Title
$title ) {
4315 $this->mConverter
->updateConversionTable( $title );
4319 * A regular expression to match legal word-trailing characters
4320 * which should be merged onto a link of the form [[foo]]bar.
4324 public function linkTrail() {
4325 return self
::$dataCache->getItem( $this->mCode
, 'linkTrail' );
4329 * A regular expression character set to match legal word-prefixing
4330 * characters which should be merged onto a link of the form foo[[bar]].
4334 public function linkPrefixCharset() {
4335 return self
::$dataCache->getItem( $this->mCode
, 'linkPrefixCharset' );
4339 * Get the "parent" language which has a converter to convert a "compatible" language
4340 * (in another variant) to this language (eg. zh for zh-cn, but not en for en-gb).
4342 * @return Language|null
4345 public function getParentLanguage() {
4346 if ( $this->mParentLanguage
!== false ) {
4347 return $this->mParentLanguage
;
4350 $code = explode( '-', $this->getCode() )[0];
4351 if ( !in_array( $code, LanguageConverter
::$languagesWithVariants ) ) {
4352 $this->mParentLanguage
= null;
4355 $lang = self
::factory( $code );
4356 if ( !$lang->hasVariant( $this->getCode() ) ) {
4357 $this->mParentLanguage
= null;
4361 $this->mParentLanguage
= $lang;
4366 * Compare with an other language object
4369 * @param Language $lang
4372 public function equals( Language
$lang ) {
4373 return $lang === $this ||
$lang->getCode() === $this->mCode
;
4377 * Get the internal language code for this language object
4379 * NOTE: The return value of this function is NOT HTML-safe and must be escaped with
4380 * htmlspecialchars() or similar
4384 public function getCode() {
4385 return $this->mCode
;
4389 * Get the code in BCP 47 format which we can use
4390 * inside of html lang="" tags.
4392 * NOTE: The return value of this function is NOT HTML-safe and must be escaped with
4393 * htmlspecialchars() or similar.
4398 public function getHtmlCode() {
4399 if ( is_null( $this->mHtmlCode
) ) {
4400 $this->mHtmlCode
= LanguageCode
::bcp47( $this->getCode() );
4402 return $this->mHtmlCode
;
4406 * @param string $code
4407 * @deprecated since 1.32, use Language::factory to create a new object instead.
4409 public function setCode( $code ) {
4410 wfDeprecated( __METHOD__
, '1.32' );
4411 $this->mCode
= $code;
4412 // Ensure we don't leave incorrect cached data lying around
4413 $this->mHtmlCode
= null;
4414 $this->mParentLanguage
= false;
4418 * Get the language code from a file name. Inverse of getFileName()
4419 * @param string $filename $prefix . $languageCode . $suffix
4420 * @param string $prefix Prefix before the language code
4421 * @param string $suffix Suffix after the language code
4422 * @return string Language code, or false if $prefix or $suffix isn't found
4424 public static function getCodeFromFileName( $filename, $prefix = 'Language', $suffix = '.php' ) {
4426 preg_match( '/' . preg_quote( $prefix, '/' ) . '([A-Z][a-z_]+)' .
4427 preg_quote( $suffix, '/' ) . '/', $filename, $m );
4428 if ( !count( $m ) ) {
4431 return str_replace( '_', '-', strtolower( $m[1] ) );
4435 * @param string $code
4436 * @param bool $fallback Whether we're going through language fallback chain
4437 * @return string Name of the language class
4439 public static function classFromCode( $code, $fallback = true ) {
4440 if ( $fallback && $code == 'en' ) {
4443 return 'Language' . str_replace( '-', '_', ucfirst( $code ) );
4448 * Get the name of a file for a certain language code
4449 * @param string $prefix Prepend this to the filename
4450 * @param string $code Language code
4451 * @param string $suffix Append this to the filename
4452 * @throws MWException
4453 * @return string $prefix . $mangledCode . $suffix
4455 public static function getFileName( $prefix, $code, $suffix = '.php' ) {
4456 if ( !self
::isValidBuiltInCode( $code ) ) {
4457 throw new MWException( "Invalid language code \"$code\"" );
4460 return $prefix . str_replace( '-', '_', ucfirst( $code ) ) . $suffix;
4464 * @param string $code
4467 public static function getMessagesFileName( $code ) {
4469 $file = self
::getFileName( "$IP/languages/messages/Messages", $code, '.php' );
4470 Hooks
::run( 'Language::getMessagesFileName', [ $code, &$file ] );
4475 * @param string $code
4477 * @throws MWException
4480 public static function getJsonMessagesFileName( $code ) {
4483 if ( !self
::isValidBuiltInCode( $code ) ) {
4484 throw new MWException( "Invalid language code \"$code\"" );
4487 return "$IP/languages/i18n/$code.json";
4491 * Get the first fallback for a given language.
4493 * @param string $code
4495 * @return bool|string
4497 public static function getFallbackFor( $code ) {
4498 $fallbacks = self
::getFallbacksFor( $code );
4500 return $fallbacks[0];
4506 * Get the ordered list of fallback languages.
4509 * @param string $code Language code
4510 * @param int $mode Fallback mode, either MESSAGES_FALLBACKS (which always falls back to 'en'),
4511 * or STRICT_FALLBACKS (whic honly falls back to 'en' when explicitly defined)
4512 * @throws MWException
4513 * @return array List of language codes
4515 public static function getFallbacksFor( $code, $mode = self
::MESSAGES_FALLBACKS
) {
4516 if ( $code === 'en' ||
!self
::isValidBuiltInCode( $code ) ) {
4520 case self
::MESSAGES_FALLBACKS
:
4521 // For unknown languages, fallbackSequence returns an empty array,
4522 // hardcode fallback to 'en' in that case as English messages are
4524 return self
::getLocalisationCache()->getItem( $code, 'fallbackSequence' ) ?
: [ 'en' ];
4525 case self
::STRICT_FALLBACKS
:
4526 // Use this mode when you don't want to fallback to English unless
4527 // explicitly defined, for example when you have language-variant icons
4528 // and an international language-independent fallback.
4529 return self
::getLocalisationCache()->getItem( $code, 'originalFallbackSequence' );
4531 throw new MWException( "Invalid fallback mode \"$mode\"" );
4536 * Get the ordered list of fallback languages, ending with the fallback
4537 * language chain for the site language.
4540 * @param string $code Language code
4541 * @return array Array( fallbacks, site fallbacks )
4543 public static function getFallbacksIncludingSiteLanguage( $code ) {
4544 global $wgLanguageCode;
4546 // Usually, we will only store a tiny number of fallback chains, so we
4547 // keep them in static memory.
4548 $cacheKey = "{$code}-{$wgLanguageCode}";
4550 if ( !array_key_exists( $cacheKey, self
::$fallbackLanguageCache ) ) {
4551 $fallbacks = self
::getFallbacksFor( $code );
4553 // Append the site's fallback chain, including the site language itself
4554 $siteFallbacks = self
::getFallbacksFor( $wgLanguageCode );
4555 array_unshift( $siteFallbacks, $wgLanguageCode );
4557 // Eliminate any languages already included in the chain
4558 $siteFallbacks = array_diff( $siteFallbacks, $fallbacks );
4560 self
::$fallbackLanguageCache[$cacheKey] = [ $fallbacks, $siteFallbacks ];
4562 return self
::$fallbackLanguageCache[$cacheKey];
4566 * Get all messages for a given language
4567 * WARNING: this may take a long time. If you just need all message *keys*
4568 * but need the *contents* of only a few messages, consider using getMessageKeysFor().
4570 * @param string $code
4574 public static function getMessagesFor( $code ) {
4575 return self
::getLocalisationCache()->getItem( $code, 'messages' );
4579 * Get a message for a given language
4581 * @param string $key
4582 * @param string $code
4586 public static function getMessageFor( $key, $code ) {
4587 return self
::getLocalisationCache()->getSubitem( $code, 'messages', $key );
4591 * Get all message keys for a given language. This is a faster alternative to
4592 * array_keys( Language::getMessagesFor( $code ) )
4595 * @param string $code Language code
4596 * @return array Array of message keys (strings)
4598 public static function getMessageKeysFor( $code ) {
4599 return self
::getLocalisationCache()->getSubitemList( $code, 'messages' );
4603 * @param string $talk
4606 function fixVariableInNamespace( $talk ) {
4607 if ( strpos( $talk, '$1' ) === false ) {
4611 global $wgMetaNamespace;
4612 $talk = str_replace( '$1', $wgMetaNamespace, $talk );
4614 # Allow grammar transformations
4615 # Allowing full message-style parsing would make simple requests
4616 # such as action=raw much more expensive than they need to be.
4617 # This will hopefully cover most cases.
4618 $talk = preg_replace_callback( '/{{grammar:(.*?)\|(.*?)}}/i',
4619 [ $this, 'replaceGrammarInNamespace' ], $talk );
4620 return str_replace( ' ', '_', $talk );
4627 function replaceGrammarInNamespace( $m ) {
4628 return $this->convertGrammar( trim( $m[2] ), trim( $m[1] ) );
4632 * Decode an expiry (block, protection, etc) which has come from the DB
4634 * @param string $expiry Database expiry String
4635 * @param bool|int $format True to process using language functions, or TS_ constant
4636 * to return the expiry in a given timestamp
4637 * @param string $infinity If $format is not true, use this string for infinite expiry
4641 public function formatExpiry( $expiry, $format = true, $infinity = 'infinity' ) {
4643 if ( $dbInfinity === null ) {
4644 $dbInfinity = wfGetDB( DB_REPLICA
)->getInfinity();
4647 if ( $expiry == '' ||
$expiry === 'infinity' ||
$expiry == $dbInfinity ) {
4648 return $format === true
4649 ?
$this->getMessageFromDB( 'infiniteblock' )
4652 return $format === true
4653 ?
$this->timeanddate( $expiry, /* User preference timezone */ true )
4654 : wfTimestamp( $format, $expiry );
4659 * Formats a time given in seconds into a string representation of that time.
4661 * @param int|float $seconds
4662 * @param array $format An optional argument that formats the returned string in different ways:
4663 * If $format['avoid'] === 'avoidseconds': don't show seconds if $seconds >= 1 hour,
4664 * If $format['avoid'] === 'avoidminutes': don't show seconds/minutes if $seconds > 48 hours,
4665 * If $format['noabbrevs'] is true: use 'seconds' and friends instead of 'seconds-abbrev'
4667 * @note For backwards compatibility, $format may also be one of the strings 'avoidseconds'
4668 * or 'avoidminutes'.
4671 function formatTimePeriod( $seconds, $format = [] ) {
4672 if ( !is_array( $format ) ) {
4673 $format = [ 'avoid' => $format ]; // For backwards compatibility
4675 if ( !isset( $format['avoid'] ) ) {
4676 $format['avoid'] = false;
4678 if ( !isset( $format['noabbrevs'] ) ) {
4679 $format['noabbrevs'] = false;
4681 $secondsMsg = wfMessage(
4682 $format['noabbrevs'] ?
'seconds' : 'seconds-abbrev' )->inLanguage( $this );
4683 $minutesMsg = wfMessage(
4684 $format['noabbrevs'] ?
'minutes' : 'minutes-abbrev' )->inLanguage( $this );
4685 $hoursMsg = wfMessage(
4686 $format['noabbrevs'] ?
'hours' : 'hours-abbrev' )->inLanguage( $this );
4687 $daysMsg = wfMessage(
4688 $format['noabbrevs'] ?
'days' : 'days-abbrev' )->inLanguage( $this );
4690 if ( round( $seconds * 10 ) < 100 ) {
4691 $s = $this->formatNum( sprintf( "%.1f", round( $seconds * 10 ) / 10 ) );
4692 $s = $secondsMsg->params( $s )->text();
4693 } elseif ( round( $seconds ) < 60 ) {
4694 $s = $this->formatNum( round( $seconds ) );
4695 $s = $secondsMsg->params( $s )->text();
4696 } elseif ( round( $seconds ) < 3600 ) {
4697 $minutes = floor( $seconds / 60 );
4698 $secondsPart = round( fmod( $seconds, 60 ) );
4699 if ( $secondsPart == 60 ) {
4703 $s = $minutesMsg->params( $this->formatNum( $minutes ) )->text();
4705 $s .= $secondsMsg->params( $this->formatNum( $secondsPart ) )->text();
4706 } elseif ( round( $seconds ) <= 2 * 86400 ) {
4707 $hours = floor( $seconds / 3600 );
4708 $minutes = floor( ( $seconds - $hours * 3600 ) / 60 );
4709 $secondsPart = round( $seconds - $hours * 3600 - $minutes * 60 );
4710 if ( $secondsPart == 60 ) {
4714 if ( $minutes == 60 ) {
4718 $s = $hoursMsg->params( $this->formatNum( $hours ) )->text();
4720 $s .= $minutesMsg->params( $this->formatNum( $minutes ) )->text();
4721 if ( !in_array( $format['avoid'], [ 'avoidseconds', 'avoidminutes' ] ) ) {
4722 $s .= ' ' . $secondsMsg->params( $this->formatNum( $secondsPart ) )->text();
4725 $days = floor( $seconds / 86400 );
4726 if ( $format['avoid'] === 'avoidminutes' ) {
4727 $hours = round( ( $seconds - $days * 86400 ) / 3600 );
4728 if ( $hours == 24 ) {
4732 $s = $daysMsg->params( $this->formatNum( $days ) )->text();
4734 $s .= $hoursMsg->params( $this->formatNum( $hours ) )->text();
4735 } elseif ( $format['avoid'] === 'avoidseconds' ) {
4736 $hours = floor( ( $seconds - $days * 86400 ) / 3600 );
4737 $minutes = round( ( $seconds - $days * 86400 - $hours * 3600 ) / 60 );
4738 if ( $minutes == 60 ) {
4742 if ( $hours == 24 ) {
4746 $s = $daysMsg->params( $this->formatNum( $days ) )->text();
4748 $s .= $hoursMsg->params( $this->formatNum( $hours ) )->text();
4750 $s .= $minutesMsg->params( $this->formatNum( $minutes ) )->text();
4752 $s = $daysMsg->params( $this->formatNum( $days ) )->text();
4754 $s .= $this->formatTimePeriod( $seconds - $days * 86400, $format );
4761 * Format a bitrate for output, using an appropriate
4762 * unit (bps, kbps, Mbps, Gbps, Tbps, Pbps, Ebps, Zbps or Ybps) according to
4763 * the magnitude in question.
4765 * This use base 1000. For base 1024 use formatSize(), for another base
4766 * see formatComputingNumbers().
4771 function formatBitrate( $bps ) {
4772 return $this->formatComputingNumbers( $bps, 1000, "bitrate-$1bits" );
4776 * @param int $size Size of the unit
4777 * @param int $boundary Size boundary (1000, or 1024 in most cases)
4778 * @param string $messageKey Message key to be uesd
4781 function formatComputingNumbers( $size, $boundary, $messageKey ) {
4783 return str_replace( '$1', $this->formatNum( $size ),
4784 $this->getMessageFromDB( str_replace( '$1', '', $messageKey ) )
4787 $sizes = [ '', 'kilo', 'mega', 'giga', 'tera', 'peta', 'exa', 'zeta', 'yotta' ];
4790 $maxIndex = count( $sizes ) - 1;
4791 while ( $size >= $boundary && $index < $maxIndex ) {
4796 // For small sizes no decimal places necessary
4799 // For MB and bigger two decimal places are smarter
4802 $msg = str_replace( '$1', $sizes[$index], $messageKey );
4804 $size = round( $size, $round );
4805 $text = $this->getMessageFromDB( $msg );
4806 return str_replace( '$1', $this->formatNum( $size ), $text );
4810 * Format a size in bytes for output, using an appropriate
4811 * unit (B, KB, MB, GB, TB, PB, EB, ZB or YB) according to the magnitude in question
4813 * This method use base 1024. For base 1000 use formatBitrate(), for
4814 * another base see formatComputingNumbers()
4816 * @param int $size Size to format
4817 * @return string Plain text (not HTML)
4819 function formatSize( $size ) {
4820 return $this->formatComputingNumbers( $size, 1024, "size-$1bytes" );
4824 * Make a list item, used by various special pages
4826 * @param string $page Page link
4827 * @param string $details HTML safe text between brackets
4828 * @param bool $oppositedm Add the direction mark opposite to your
4829 * language, to display text properly
4830 * @return string HTML escaped
4832 function specialList( $page, $details, $oppositedm = true ) {
4837 $dirmark = ( $oppositedm ?
$this->getDirMark( true ) : '' ) . $this->getDirMark();
4840 $this->msg( 'word-separator' )->escaped() .
4841 $this->msg( 'parentheses' )->rawParams( $details )->escaped();
4845 * Generate (prev x| next x) (20|50|100...) type links for paging
4847 * @param Title $title Title object to link
4848 * @param int $offset
4850 * @param array $query Optional URL query parameter string
4851 * @param bool $atend Optional param for specified if this is the last page
4853 * @deprecated since 1.33, use SpecialPage::viewPrevNext()
4856 public function viewPrevNext( Title
$title, $offset, $limit,
4857 array $query = [], $atend = false
4859 // @todo FIXME: Why on earth this needs one message for the text and another one for tooltip?
4861 # Make 'previous' link
4862 $prev = wfMessage( 'prevn' )->inLanguage( $this )->title( $title )->numParams( $limit )->text();
4863 if ( $offset > 0 ) {
4864 $plink = $this->numLink( $title, max( $offset - $limit, 0 ), $limit,
4865 $query, $prev, 'prevn-title', 'mw-prevlink' );
4867 $plink = htmlspecialchars( $prev );
4871 $next = wfMessage( 'nextn' )->inLanguage( $this )->title( $title )->numParams( $limit )->text();
4873 $nlink = htmlspecialchars( $next );
4875 $nlink = $this->numLink( $title, $offset +
$limit, $limit,
4876 $query, $next, 'nextn-title', 'mw-nextlink' );
4879 # Make links to set number of items per page
4881 foreach ( [ 20, 50, 100, 250, 500 ] as $num ) {
4882 $numLinks[] = $this->numLink( $title, $offset, $num,
4883 $query, $this->formatNum( $num ), 'shown-title', 'mw-numlink' );
4886 return wfMessage( 'viewprevnext' )->inLanguage( $this )->title( $title
4887 )->rawParams( $plink, $nlink, $this->pipeList( $numLinks ) )->escaped();
4891 * Helper function for viewPrevNext() that generates links
4893 * @param Title $title Title object to link
4894 * @param int $offset
4896 * @param array $query Extra query parameters
4897 * @param string $link Text to use for the link; will be escaped
4898 * @param string $tooltipMsg Name of the message to use as tooltip
4899 * @param string $class Value of the "class" attribute of the link
4900 * @return string HTML fragment
4902 private function numLink( Title
$title, $offset, $limit, array $query, $link,
4905 $query = [ 'limit' => $limit, 'offset' => $offset ] +
$query;
4906 $tooltip = wfMessage( $tooltipMsg )->inLanguage( $this )->title( $title )
4907 ->numParams( $limit )->text();
4909 return Html
::element( 'a', [ 'href' => $title->getLocalURL( $query ),
4910 'title' => $tooltip, 'class' => $class ], $link );
4914 * Get the conversion rule title, if any.
4918 public function getConvRuleTitle() {
4919 return $this->mConverter
->getConvRuleTitle();
4923 * Get the compiled plural rules for the language
4925 * @return array Associative array with plural form, and plural rule as key-value pairs
4927 public function getCompiledPluralRules() {
4928 $pluralRules = self
::$dataCache->getItem( strtolower( $this->mCode
), 'compiledPluralRules' );
4929 $fallbacks = self
::getFallbacksFor( $this->mCode
);
4930 if ( !$pluralRules ) {
4931 foreach ( $fallbacks as $fallbackCode ) {
4932 $pluralRules = self
::$dataCache->getItem( strtolower( $fallbackCode ), 'compiledPluralRules' );
4933 if ( $pluralRules ) {
4938 return $pluralRules;
4942 * Get the plural rules for the language
4944 * @return array Associative array with plural form number and plural rule as key-value pairs
4946 public function getPluralRules() {
4947 $pluralRules = self
::$dataCache->getItem( strtolower( $this->mCode
), 'pluralRules' );
4948 $fallbacks = self
::getFallbacksFor( $this->mCode
);
4949 if ( !$pluralRules ) {
4950 foreach ( $fallbacks as $fallbackCode ) {
4951 $pluralRules = self
::$dataCache->getItem( strtolower( $fallbackCode ), 'pluralRules' );
4952 if ( $pluralRules ) {
4957 return $pluralRules;
4961 * Get the plural rule types for the language
4963 * @return array Associative array with plural form number and plural rule type as key-value pairs
4965 public function getPluralRuleTypes() {
4966 $pluralRuleTypes = self
::$dataCache->getItem( strtolower( $this->mCode
), 'pluralRuleTypes' );
4967 $fallbacks = self
::getFallbacksFor( $this->mCode
);
4968 if ( !$pluralRuleTypes ) {
4969 foreach ( $fallbacks as $fallbackCode ) {
4970 $pluralRuleTypes = self
::$dataCache->getItem( strtolower( $fallbackCode ), 'pluralRuleTypes' );
4971 if ( $pluralRuleTypes ) {
4976 return $pluralRuleTypes;
4980 * Find the index number of the plural rule appropriate for the given number
4981 * @param int $number
4982 * @return int The index number of the plural rule
4984 public function getPluralRuleIndexNumber( $number ) {
4985 $pluralRules = $this->getCompiledPluralRules();
4986 $form = Evaluator
::evaluateCompiled( $number, $pluralRules );
4991 * Find the plural rule type appropriate for the given number
4992 * For example, if the language is set to Arabic, getPluralType(5) should
4995 * @param int $number
4996 * @return string The name of the plural rule type, e.g. one, two, few, many
4998 public function getPluralRuleType( $number ) {
4999 $index = $this->getPluralRuleIndexNumber( $number );
5000 $pluralRuleTypes = $this->getPluralRuleTypes();
5001 return $pluralRuleTypes[$index] ??
'other';