| blob | 38d3af5c8521ec5f9ea2578f14658d095c6794f9 |
1 <?php
2 /**
3 * Internationalisation code.
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
19 *
20 * @file
21 * @ingroup Language
22 */
24 /**
25 * @defgroup Language Language
26 */
31 }
35 }
37 /**
38 * Internationalisation code
39 * @ingroup Language
40 */
42 /**
43 * @var LanguageConverter
44 */
56 /**
57 * ReplacementArray object caches
58 */
61 /**
62 * @var LocalisationCache
63 */
71 );
75 );
80 'december'
81 );
85 'december-gen'
86 );
90 );
97 );
105 );
113 );
120 );
122 /**
123 * @since 1.20
124 * @var array
125 */
136 );
138 /**
139 * Cache for language fallbacks.
140 * @see Language::getFallbacksIncludingSiteLanguage
141 * @since 1.21
142 * @var array
143 */
146 /**
147 * Get a cached or new language object for a given language code
148 * @param string $code
149 * @return Language
150 */
156 }
158 // get the language object to process
163 // merge the language object in to get it up front in the cache
165 // get rid of the oldest ones in case we have an overflow
169 }
171 /**
172 * Create a language object for a given language code
173 * @param string $code
174 * @throws MWException
175 * @return Language
176 */
178 // Protect against path traversal below
181 ) {
183 }
186 // It's not possible to customise this code with class files, so
187 // just return a Language object. This is to support uselang= hacks.
191 }
193 // Check if there is a language class for the code
199 }
201 // Keep trying the fallback list until we find an existing class
206 }
214 }
215 }
218 }
220 /**
221 * Checks whether any localisation is available for that language tag
222 * in MediaWiki (MessagesXx.php exists).
223 *
224 * @param string $code Language tag (in lower case)
225 * @return bool Whether language is supported
226 * @since 1.21
227 */
232 );
233 }
235 /**
236 * Returns true if a language code string is a well-formed language tag
237 * according to RFC 5646.
238 * This function only checks well-formedness; it doesn't check that
239 * language, script or variant codes actually exist in the repositories.
240 *
241 * Based on regexes by Mark Davis of the Unicode Consortium:
242 * http://unicode.org/repos/cldr/trunk/tools/java/org/unicode/cldr/util/data/langtagRegex.txt
243 *
244 * @param string $code
245 * @param bool $lenient Whether to allow '_' as separator. The default is only '-'.
246 *
247 * @return bool
248 * @since 1.21
249 */
265 # Define certain grandfathered codes, since otherwise the regex is pretty useless.
266 # Since these are limited, this is safe even later changes to the registry --
267 # the only oddity is that it might change the type of the tag, and thus
268 # the results from the capturing groups.
269 # http://www.iana.org/assignments/language-subtag-registry
287 # The final breakdown, with capturing groups for each of these components
288 # The variants, extensions, grandfathered, and private-use may have interior '-'
293 }
295 /**
296 * Returns true if a language code string is of a valid form, whether or
297 * not it exists. This includes codes which are used solely for
298 * customisation via the MediaWiki namespace.
299 *
300 * @param string $code
301 *
302 * @return bool
303 */
308 }
309 // People think language codes are html safe, so enforce it.
310 // Ideally we should only allow a-zA-Z0-9-
311 // but, .+ and other chars are often used for {{int:}} hacks
312 // see bugs 37564, 37587, 36938
318 }
320 /**
321 * Returns true if a language code is of a valid form for the purposes of
322 * internal customisation of MediaWiki, via Messages*.php or *.json.
323 *
324 * @param string $code
325 *
326 * @throws MWException
327 * @since 1.18
328 * @return bool
329 */
337 }
340 }
343 }
345 /**
346 * Returns true if a language code is an IETF tag known to MediaWiki.
347 *
348 * @param string $code
349 *
350 * @since 1.21
351 * @return bool
352 */
356 // Quick escape for invalid input to avoid exceptions down the line
357 // when code tries to process tags which are not valid at all.
360 }
365 }
369 ) {
371 }
374 }
376 /**
377 * @param string $code
378 * @return string Name of the language class
379 */
385 }
386 }
388 /**
389 * Includes language class files
390 *
391 * @param string $class Name of the language class
392 */
398 }
402 }
403 }
405 /**
406 * Get the LocalisationCache instance
407 *
408 * @return LocalisationCache
409 */
415 }
417 }
421 // Set the code to the name of the descendant
426 }
428 }
430 /**
431 * Reduce memory usage
432 */
436 }
437 }
439 /**
440 * Hook which will be called if this is the content language.
441 * Descendants can use this to register hook functions or modify globals
442 */
444 }
446 /**
447 * Same as getFallbacksFor for current language.
448 * @return array|bool
449 * @deprecated since 1.19
450 */
455 }
457 /**
458 * @return array
459 * @since 1.19
460 */
463 }
465 /**
466 * Exports $wgBookstoreListEn
467 * @return array
468 */
471 }
473 /**
474 * Returns an array of localised namespaces indexed by their numbers. If the namespace is not
475 * available in localised form, it will be included in English.
476 *
477 * @return array
478 */
495 }
497 # Sometimes a language will be localised but not actually exist on this wiki.
501 }
502 }
504 # The above mixing may leave namespaces out of canonical order.
505 # Re-order by namespace ID number...
509 }
512 }
514 /**
515 * Arbitrarily set all of the namespace names at once. Mainly used for testing
516 * @param array $namespaces Array of namespaces (id => name)
517 */
521 }
523 /**
524 * Resets all of the namespace caches. Mainly used for testing
525 */
530 }
532 /**
533 * A convenience function that returns the same thing as
534 * getNamespaces() except with the array values changed to ' '
535 * where it found '_', useful for producing output to be displayed
536 * e.g. in <select> forms.
537 *
538 * @return array
539 */
544 }
546 }
548 /**
549 * Get a namespace value by key
550 * <code>
551 * $mw_ns = $wgContLang->getNsText( NS_MEDIAWIKI );
552 * echo $mw_ns; // prints 'MediaWiki'
553 * </code>
554 *
555 * @param int $index The array key of the namespace to return
556 * @return string|bool String if the namespace value exists, otherwise false
557 */
562 }
564 /**
565 * A convenience function that returns the same thing as
566 * getNsText() except with '_' changed to ' ', useful for
567 * producing output.
568 *
569 * <code>
570 * $mw_ns = $wgContLang->getFormattedNsText( NS_MEDIAWIKI_TALK );
571 * echo $mw_ns; // prints 'MediaWiki talk'
572 * </code>
573 *
574 * @param int $index The array key of the namespace to return
575 * @return string Namespace name without underscores (empty string if namespace does not exist)
576 */
581 }
583 /**
584 * Returns gender-dependent namespace alias if available.
585 * See https://www.mediawiki.org/wiki/Manual:$wgExtraGenderNamespaces
586 * @param int $index Namespace index
587 * @param string $gender Gender key (male, female... )
588 * @return string
589 * @since 1.18
590 */
598 }
600 /**
601 * Whether this language uses gender-dependent namespace aliases.
602 * See https://www.mediawiki.org/wiki/Manual:$wgExtraGenderNamespaces
603 * @return bool
604 * @since 1.18
605 */
609 // $wgExtraGenderNamespaces overrides everything
611 } elseif ( isset( $wgExtraNamespaces[NS_USER] ) && isset( $wgExtraNamespaces[NS_USER_TALK] ) ) {
612 /// @todo There may be other gender namespace than NS_USER & NS_USER_TALK in the future
613 // $wgExtraNamespaces overrides any gender aliases specified in i18n files
616 // Check what is in i18n files
619 }
620 }
622 /**
623 * Get a namespace key by value, case insensitive.
624 * Only matches namespace names for the current language, not the
625 * canonical ones defined in Namespace.php.
626 *
627 * @param string $text
628 * @return int|bool An integer if $text is a valid value otherwise false
629 */
634 }
636 /**
637 * @return array
638 */
650 }
651 }
652 }
660 }
661 }
663 # Also add converted namespace names as aliases, to avoid confusion.
668 }
671 }
672 }
675 }
678 }
680 /**
681 * @return array
682 */
686 # Put namespace names and aliases into a hashtable.
687 # If this is too slow, then we should arrange it so that it is done
688 # before caching. The catch is that at pre-cache time, the above
689 # class-specific fixup hasn't been done.
693 }
696 }
700 }
701 }
702 }
704 }
706 /**
707 * Get a namespace key by value, case insensitive. Canonical namespace
708 * names override custom ones defined for the current language.
709 *
710 * @param string $text
711 * @return int|bool An integer if $text is a valid value otherwise false
712 */
718 }
721 }
723 /**
724 * short names for language variants used for language conversion links.
725 *
726 * @param string $code
727 * @param bool $usemsg Use the "variantname-xyz" message if it exists
728 * @return string
729 */
734 }
739 # otherwise, output the language code
741 }
742 }
744 /**
745 * @param string $name
746 * @return string
747 */
752 }
754 }
756 /**
757 * @return array
758 */
761 }
763 /**
764 * @return array
765 */
768 }
770 /**
771 * @return array|string
772 */
780 }
781 }
783 /**
784 * @return array
785 */
788 }
790 /**
791 * @param string $image
792 * @return array|null
793 */
796 }
798 /**
799 * @return array
800 */
803 }
805 /**
806 * @param string $tog
807 * @return string
808 */
811 }
813 /**
814 * Get native language names, indexed by code.
815 * Only those defined in MediaWiki, no other data like CLDR.
816 * If $customisedOnly is true, only returns codes with a messages file
817 *
818 * @param bool $customisedOnly
819 *
820 * @return array
821 * @deprecated since 1.20, use fetchLanguageNames()
822 */
825 }
827 /**
828 * Get translated language names. This is done on best effort and
829 * by default this is exactly the same as Language::getLanguageNames.
830 * The CLDR extension provides translated names.
831 * @param string $code Language code.
832 * @return array Language code => language name
833 * @since 1.18.0
834 * @deprecated since 1.20, use fetchLanguageNames()
835 */
838 }
840 /**
841 * Get an array of language names, indexed by code.
842 * @param null|string $inLanguage Code of language in which to return the names
843 * Use null for autonyms (native names)
844 * @param string $include One of:
845 * 'all' all available languages
846 * 'mw' only if the language is defined in MediaWiki or wgExtraLanguageNames (default)
847 * 'mwfile' only if the language is in 'mw' *and* has a message file
848 * @return array Language code => language name
849 * @since 1.20
850 */
858 }
863 # TODO: also include when $inLanguage is null, when this code is more efficient
865 }
869 # - Prefer own MediaWiki native name when not using the hook
870 # - For other names just add if not added through the hook
873 }
874 }
878 }
884 }
888 # We do this using a foreach over the codes instead of a directory
889 # loop so that messages files in extensions will work correctly.
893 ) {
895 }
896 }
899 }
901 # 'mw' option; default if it's not one of the other two options (all/mwfile)
903 }
905 /**
906 * @param string $code The code of the language for which to get the name
907 * @param null|string $inLanguage Code of language in which to return the name (null for autonyms)
908 * @param string $include 'all', 'mw' or 'mwfile'; see fetchLanguageNames()
909 * @return string Language name or empty
910 * @since 1.20
911 */
916 }
918 /**
919 * Get a message from the MediaWiki namespace.
920 *
921 * @param string $msg Message name
922 * @return string
923 */
926 }
928 /**
929 * Get the native language name of $code.
930 * Only if defined in MediaWiki, no other data like CLDR.
931 * @param string $code
932 * @return string
933 * @deprecated since 1.20, use fetchLanguageName()
934 */
937 }
939 /**
940 * @param string $key
941 * @return string
942 */
945 }
947 /**
948 * @return array
949 */
954 }
956 }
958 /**
959 * @param string $key
960 * @return string
961 */
964 }
966 /**
967 * @param string $key
968 * @return string
969 */
972 }
974 /**
975 * @return array
976 */
981 }
983 }
985 /**
986 * @param string $key
987 * @return string
988 */
991 }
993 /**
994 * @param string $key
995 * @return string
996 */
999 }
1001 /**
1002 * @param string $key
1003 * @return string
1004 */
1007 }
1009 /**
1010 * @param string $key
1011 * @return string
1012 */
1015 }
1017 /**
1018 * @param string $key
1019 * @return string
1020 */
1023 }
1025 /**
1026 * @param string $key
1027 * @return string
1028 */
1031 }
1033 /**
1034 * This is a workalike of PHP's date() function, but with better
1035 * internationalisation, a reduced set of format characters, and a better
1036 * escaping format.
1037 *
1038 * Supported format characters are dDjlNwzWFmMntLoYyaAgGhHiscrUeIOPTZ. See
1039 * the PHP manual for definitions. There are a number of extensions, which
1040 * start with "x":
1041 *
1042 * xn Do not translate digits of the next numeric format character
1043 * xN Toggle raw digit (xn) flag, stays set until explicitly unset
1044 * xr Use roman numerals for the next numeric format character
1045 * xh Use hebrew numerals for the next numeric format character
1046 * xx Literal x
1047 * xg Genitive month name
1048 *
1049 * xij j (day number) in Iranian calendar
1050 * xiF F (month name) in Iranian calendar
1051 * xin n (month number) in Iranian calendar
1052 * xiy y (two digit year) in Iranian calendar
1053 * xiY Y (full year) in Iranian calendar
1054 *
1055 * xjj j (day number) in Hebrew calendar
1056 * xjF F (month name) in Hebrew calendar
1057 * xjt t (days in month) in Hebrew calendar
1058 * xjx xg (genitive month name) in Hebrew calendar
1059 * xjn n (month number) in Hebrew calendar
1060 * xjY Y (full year) in Hebrew calendar
1061 *
1062 * xmj j (day number) in Hijri calendar
1063 * xmF F (month name) in Hijri calendar
1064 * xmn n (month number) in Hijri calendar
1065 * xmY Y (full year) in Hijri calendar
1066 *
1067 * xkY Y (full year) in Thai solar calendar. Months and days are
1068 * identical to the Gregorian calendar
1069 * xoY Y (full year) in Minguo calendar or Juche year.
1070 * Months and days are identical to the
1071 * Gregorian calendar
1072 * xtY Y (full year) in Japanese nengo. Months and days are
1073 * identical to the Gregorian calendar
1074 *
1075 * Characters enclosed in double quotes will be considered literal (with
1076 * the quotes themselves removed). Unmatched quotes will be considered
1077 * literal quotes. Example:
1078 *
1079 * "The month is" F => The month is January
1080 * i's" => 20'11"
1081 *
1082 * Backslash escaping is also supported.
1083 *
1084 * Input timestamp is assumed to be pre-normalized to the desired local
1085 * time zone, if any. Note that the format characters crUeIOPTZ will assume
1086 * $ts is UTC if $zone is not given.
1087 *
1088 * @param string $format
1089 * @param string $ts 14-character timestamp
1090 * YYYYMMDDHHMMSS
1091 * 01234567890123
1092 * @param DateTimeZone $zone Timezone of $ts
1093 * @todo handling of "o" format character for Iranian, Hebrew, Hijri & Thai?
1094 *
1095 * @throws MWException
1096 * @return string
1097 */
1114 }
1118 }
1126 }
1136 }
1160 }
1170 );
1171 }
1180 }
1186 }
1192 }
1199 );
1200 }
1209 }
1215 }
1221 }
1236 }
1242 }
1248 }
1254 }
1263 }
1269 }
1275 }
1281 }
1287 }
1293 }
1302 }
1337 // Pass through string from $dateTimeObj->format()
1341 );
1342 }
1355 // Pass through number from $dateTimeObj->format()
1359 );
1360 }
1364 # Backslash escaping
1369 }
1372 # Quoted literal
1376 # No terminating quote, assume literal "
1381 }
1383 # Quote at end of string, assume literal "
1385 }
1389 }
1402 }
1403 }
1404 }
1407 }
1412 /**
1413 * Algorithm by Roozbeh Pournader and Mohammad Toossi to convert
1414 * Gregorian dates to Iranian dates. Originally written in C, it
1415 * is released under the terms of GNU Lesser General Public
1416 * License. Conversion to PHP was performed by Niklas Laxström.
1417 *
1418 * Link: http://www.farsiweb.info/jalali/jalali.c
1419 *
1420 * @param string $ts
1421 *
1422 * @return string
1423 */
1429 # Days passed from the beginning (including leap years)
1435 // Add days of the past months of this year
1438 }
1440 // Leap years
1443 }
1445 // Days passed in current month
1459 }
1463 }
1469 }
1471 /**
1472 * Converting Gregorian dates to Hijri dates.
1473 *
1474 * Based on a PHP-Nuke block by Sharjeel which is released under GNU/GPL license
1475 *
1476 * @see http://phpnuke.org/modules.php?name=News&file=article&sid=8234&mode=thread&order=0&thold=0
1477 *
1478 * @param string $ts
1479 *
1480 * @return string
1481 */
1495 ) {
1503 }
1517 }
1519 /**
1520 * Converting Gregorian dates to Hebrew dates.
1521 *
1522 * Based on a JavaScript code by Abu Mami and Yisrael Hersch
1523 * (abu-mami@kaluach.net, http://www.kaluach.net), who permitted
1524 * to translate the relevant functions into PHP and release them under
1525 * GNU GPL.
1526 *
1527 * The months are counted from Tishrei = 1. In a leap year, Adar I is 13
1528 * and Adar II is 14. In a non-leap year, Adar is 6.
1529 *
1530 * @param string $ts
1531 *
1532 * @return string
1533 */
1535 # Parse date
1540 # Calculate Hebrew year
1543 # Month number when September = 1, August = 12
1546 # Next year
1550 }
1552 # Calculate day of year from 1 September
1556 # February
1558 # Check if the year is leap
1561 }
1566 }
1567 }
1569 # Calculate the start of the Hebrew year
1572 # Calculate next year's start
1574 # Day is before the start of the year - it is the previous year
1575 # Next year's start
1577 # Previous year
1580 # Add days since previous year's 1 September
1583 # Leap year
1585 }
1586 # Start of the new (previous) year
1589 # Next year's start
1591 }
1593 # Calculate Hebrew day of year
1596 # Difference between year's days
1598 # Add 12 (or 13 for leap years) days to ignore the difference between
1599 # Hebrew and Gregorian year (353 at least vs. 365/6) - now the
1600 # difference is only about the year type
1605 }
1607 # Check the year pattern, and is leap year
1608 # 0 means an incomplete year, 1 means a regular year, 2 means a complete year
1609 # This is mod 30, to work on both leap years (which add 30 days of Adar I)
1610 # and non-leap years
1612 # Check if leap year
1615 # Calculate day in the month from number of day in the Hebrew year
1616 # Don't check Adar - if the day is not in Adar, we will stop before;
1617 # if it is in Adar, we will use it to check if it is Adar I or Adar II
1622 # Calculate days in this month
1624 # Adar in a leap year
1626 # Leap year - has Adar I, with 30 days, and Adar II, with 29 days
1629 # Day in Adar I
1632 # Subtract the days of Adar I
1634 # Try Adar II
1637 # Day in Adar II
1639 }
1640 }
1641 }
1643 # Cheshvan in a complete year (otherwise as the rule below)
1646 # Kislev in an incomplete year (otherwise as the rule below)
1649 # Odd months have 30 days, even have 29
1651 }
1653 # In the current month
1656 # Subtract the days of the current month
1658 # Try in the next month
1660 }
1661 }
1664 }
1666 /**
1667 * This calculates the Hebrew year start, as days since 1 September.
1668 * Based on Carl Friedrich Gauss algorithm for finding Easter date.
1669 * Used for Hebrew date.
1670 *
1671 * @param int $year
1672 *
1673 * @return string
1674 */
1681 }
1685 }
1695 }
1699 }
1701 /**
1702 * Algorithm to convert Gregorian dates to Thai solar dates,
1703 * Minguo dates or Minguo dates.
1704 *
1705 * Link: http://en.wikipedia.org/wiki/Thai_solar_calendar
1706 * http://en.wikipedia.org/wiki/Minguo_calendar
1707 * http://en.wikipedia.org/wiki/Japanese_era_name
1708 *
1709 * @param string $ts 14-character timestamp
1710 * @param string $cName Calender name
1711 * @return array Converted year, month, day
1712 */
1719 # Thai solar dates
1720 # Add 543 years to the Gregorian calendar
1721 # Months and days are identical
1724 # Minguo dates
1725 # Deduct 1911 years from the Gregorian calendar
1726 # Months and days are identical
1729 # Nengō dates up to Meiji period
1730 # Deduct years from the Gregorian calendar
1731 # depending on the nengo periods
1732 # Months and days are identical
1736 ) {
1737 # Meiji period
1742 }
1750 ) {
1751 # Taishō period
1756 }
1762 ) {
1763 # Shōwa period
1768 }
1771 # Heisei period
1776 }
1778 }
1781 }
1784 }
1786 /**
1787 * Roman number formatting up to 10000
1788 *
1789 * @param int $num
1790 *
1791 * @return string
1792 */
1800 );
1805 }
1811 }
1813 }
1815 }
1817 /**
1818 * Hebrew Gematria number formatting up to 9999
1819 *
1820 * @param int $num
1821 *
1822 * @return string
1823 */
1830 );
1835 }
1847 }
1848 }
1849 }
1851 }
1857 }
1876 }
1878 }
1880 /**
1881 * Used by date() and time() to adjust the time output.
1882 *
1883 * @param int $ts The time in date('YmdHis') format
1884 * @param mixed $tz Adjust the time by this amount (default false, mean we
1885 * get user timecorrection setting)
1886 * @return int
1887 */
1893 }
1906 }
1907 # Unrecognized timezone, default to 'Offset' with the stored offset.
1909 }
1912 # Global offset in minutes.
1924 }
1927 }
1928 }
1930 # No difference ? Return time unchanged
1933 }
1936 # Generate an adjusted date; take advantage of the fact that mktime
1937 # will normalize out-of-range values so we don't have to split $minDiff
1938 # into hours and minutes.
1951 }
1953 /**
1954 * This is meant to be used by time(), date(), and timeanddate() to get
1955 * the date preference they're supposed to use, it should be used in
1956 * all children.
1957 *
1958 *<code>
1959 * function timeanddate([...], $format = true) {
1960 * $datePreference = $this->dateFormat($format);
1961 * [...]
1962 * }
1963 *</code>
1964 *
1965 * @param int|string|bool $usePrefs If true, the user's preference is used
1966 * if false, the site/language default is used
1967 * if int/string, assumed to be a format.
1968 * @return string
1969 */
1978 }
1981 }
1983 // return int
1986 }
1989 }
1991 /**
1992 * Get a format string for a given type and preference
1993 * @param string $type May be date, time or both
1994 * @param string $pref The format name as it appears in Messages*.php
1995 *
1996 * @since 1.22 New type 'pretty' that provides a more readable timestamp format
1997 *
1998 * @return string
1999 */
2010 }
2015 }
2016 }
2018 }
2020 }
2022 /**
2023 * @param mixed $ts The time format which needs to be turned into a
2024 * date('YmdHis') format with wfTimestamp(TS_MW,$ts)
2025 * @param bool $adj Whether to adjust the time output according to the
2026 * user configured offset ($timecorrection)
2027 * @param mixed $format True to use user's date format preference
2028 * @param string|bool $timecorrection The time offset as returned by
2029 * validateTimeZone() in Special:Preferences
2030 * @return string
2031 */
2036 }
2039 }
2041 /**
2042 * @param mixed $ts The time format which needs to be turned into a
2043 * date('YmdHis') format with wfTimestamp(TS_MW,$ts)
2044 * @param bool $adj Whether to adjust the time output according to the
2045 * user configured offset ($timecorrection)
2046 * @param mixed $format True to use user's date format preference
2047 * @param string|bool $timecorrection The time offset as returned by
2048 * validateTimeZone() in Special:Preferences
2049 * @return string
2050 */
2055 }
2058 }
2060 /**
2061 * @param mixed $ts The time format which needs to be turned into a
2062 * date('YmdHis') format with wfTimestamp(TS_MW,$ts)
2063 * @param bool $adj Whether to adjust the time output according to the
2064 * user configured offset ($timecorrection)
2065 * @param mixed $format What format to return, if it's false output the
2066 * default one (default true)
2067 * @param string|bool $timecorrection The time offset as returned by
2068 * validateTimeZone() in Special:Preferences
2069 * @return string
2070 */
2075 }
2078 }
2080 /**
2081 * Takes a number of seconds and turns it into a text using values such as hours and minutes.
2082 *
2083 * @since 1.20
2084 *
2085 * @param int $seconds The amount of seconds.
2086 * @param array $chosenIntervals The intervals to enable.
2087 *
2088 * @return string
2089 */
2096 // Messages: duration-seconds, duration-minutes, duration-hours, duration-days, duration-weeks,
2097 // duration-years, duration-decades, duration-centuries, duration-millennia
2100 }
2103 }
2105 /**
2106 * Takes a number of seconds and returns an array with a set of corresponding intervals.
2107 * For example 65 will be turned into array( minutes => 1, seconds => 5 ).
2108 *
2109 * @since 1.20
2110 *
2111 * @param int $seconds The amount of seconds.
2112 * @param array $chosenIntervals The intervals to enable.
2113 *
2114 * @return array
2115 */
2126 'seconds'
2127 );
2128 }
2142 }
2143 }
2146 }
2148 /**
2149 * Internal helper function for userDate(), userTime() and userTimeAndDate()
2150 *
2151 * @param string $type Can be 'date', 'time' or 'both'
2152 * @param mixed $ts The time format which needs to be turned into a
2153 * date('YmdHis') format with wfTimestamp(TS_MW,$ts)
2154 * @param User $user User object used to get preferences for timezone and format
2155 * @param array $options Array, can contain the following keys:
2156 * - 'timecorrection': time correction, can have the following values:
2157 * - true: use user's preference
2158 * - false: don't use time correction
2159 * - int: value of time correction in minutes
2160 * - 'format': format to use, can have the following values:
2161 * - true: use user's preference
2162 * - false: use default preference
2163 * - string: format to use
2164 * @since 1.19
2165 * @return string
2166 */
2175 }
2177 }
2182 }
2185 }
2187 /**
2188 * Get the formatted date for the given timestamp and formatted for
2189 * the given user.
2190 *
2191 * @param mixed $ts Mixed: the time format which needs to be turned into a
2192 * date('YmdHis') format with wfTimestamp(TS_MW,$ts)
2193 * @param User $user User object used to get preferences for timezone and format
2194 * @param array $options Array, can contain the following keys:
2195 * - 'timecorrection': time correction, can have the following values:
2196 * - true: use user's preference
2197 * - false: don't use time correction
2198 * - int: value of time correction in minutes
2199 * - 'format': format to use, can have the following values:
2200 * - true: use user's preference
2201 * - false: use default preference
2202 * - string: format to use
2203 * @since 1.19
2204 * @return string
2205 */
2208 }
2210 /**
2211 * Get the formatted time for the given timestamp and formatted for
2212 * the given user.
2213 *
2214 * @param mixed $ts The time format which needs to be turned into a
2215 * date('YmdHis') format with wfTimestamp(TS_MW,$ts)
2216 * @param User $user User object used to get preferences for timezone and format
2217 * @param array $options Array, can contain the following keys:
2218 * - 'timecorrection': time correction, can have the following values:
2219 * - true: use user's preference
2220 * - false: don't use time correction
2221 * - int: value of time correction in minutes
2222 * - 'format': format to use, can have the following values:
2223 * - true: use user's preference
2224 * - false: use default preference
2225 * - string: format to use
2226 * @since 1.19
2227 * @return string
2228 */
2231 }
2233 /**
2234 * Get the formatted date and time for the given timestamp and formatted for
2235 * the given user.
2236 *
2237 * @param mixed $ts the time format which needs to be turned into a
2238 * date('YmdHis') format with wfTimestamp(TS_MW,$ts)
2239 * @param User $user User object used to get preferences for timezone and format
2240 * @param array $options Array, can contain the following keys:
2241 * - 'timecorrection': time correction, can have the following values:
2242 * - true: use user's preference
2243 * - false: don't use time correction
2244 * - int: value of time correction in minutes
2245 * - 'format': format to use, can have the following values:
2246 * - true: use user's preference
2247 * - false: use default preference
2248 * - string: format to use
2249 * @since 1.19
2250 * @return string
2251 */
2254 }
2256 /**
2257 * Convert an MWTimestamp into a pretty human-readable timestamp using
2258 * the given user preferences and relative base time.
2259 *
2260 * DO NOT USE THIS FUNCTION DIRECTLY. Instead, call MWTimestamp::getHumanTimestamp
2261 * on your timestamp object, which will then call this function. Calling
2262 * this function directly will cause hooks to be skipped over.
2263 *
2264 * @see MWTimestamp::getHumanTimestamp
2265 * @param MWTimestamp $ts Timestamp to prettify
2266 * @param MWTimestamp $relativeTo Base timestamp
2267 * @param User $user User preferences to use
2268 * @return string Human timestamp
2269 * @since 1.22
2270 */
2278 ) {
2279 // Timestamps are in different years: use full timestamp
2280 // Also do full timestamp for future dates
2281 /**
2282 * @FIXME Add better handling of future timestamps.
2283 */
2287 // Timestamps are in same year, but more than 5 days ago: show day and month only.
2291 // Timestamp within the past week: show the day of the week and time
2294 // Messages:
2295 // sunday-at, monday-at, tuesday-at, wednesday-at, thursday-at, friday-at, saturday-at
2301 // Timestamp was yesterday: say 'yesterday' and the time.
2308 // Timestamp was today, but more than 90 minutes ago: say 'today' and the time.
2315 // From here on in, the timestamp was soon enough ago so that we can simply say
2316 // XX units ago, e.g., "2 hours ago" or "5 minutes ago"
2318 // Less than 90 minutes, but more than an hour ago.
2321 // A few minutes ago.
2324 // Less than a minute, but more than 30 sec ago.
2327 // Less than 30 seconds ago.
2329 }
2332 }
2334 /**
2335 * @param string $key
2336 * @return array|null
2337 */
2340 }
2342 /**
2343 * @return array
2344 */
2347 }
2349 /**
2350 * @param string $in
2351 * @param string $out
2352 * @param string $string
2353 * @return string
2354 */
2356 # This is a wrapper for iconv in all languages except esperanto,
2357 # which does some nasty x-conversions beforehand
2359 # Even with //IGNORE iconv can whine about illegal characters in
2360 # *input* string. We just ignore those too.
2361 # REF: http://bugs.php.net/bug.php?id=37166
2362 # REF: https://bugzilla.wikimedia.org/show_bug.cgi?id=16885
2367 }
2369 // callback functions for uc(), lc(), ucwords(), ucwordbreaks()
2371 /**
2372 * @param array $matches
2373 * @return mixed|string
2374 */
2377 }
2379 /**
2380 * @param array $matches
2381 * @return string
2382 */
2385 }
2387 /**
2388 * @param array $matches
2389 * @return string
2390 */
2394 }
2396 /**
2397 * @param array $matches
2398 * @return string
2399 */
2403 }
2405 /**
2406 * @param array $matches
2407 * @return string
2408 */
2411 }
2413 /**
2414 * @param array $matches
2415 * @return string
2416 */
2420 }
2422 /**
2423 * Make a string's first character uppercase
2424 *
2425 * @param string $str
2426 *
2427 * @return string
2428 */
2436 // fall back to more complex logic in case of multibyte strings
2438 }
2439 }
2441 /**
2442 * Convert a string to uppercase
2443 *
2444 * @param string $str
2445 * @param bool $first
2446 *
2447 * @return string
2448 */
2456 }
2459 }
2466 $str
2467 );
2470 }
2471 }
2472 }
2474 /**
2475 * @param string $str
2476 * @return mixed|string
2477 */
2489 }
2490 }
2492 /**
2493 * @param string $str
2494 * @param bool $first
2495 * @return mixed|string
2496 */
2504 }
2507 }
2514 $str
2515 );
2518 }
2519 }
2520 }
2522 /**
2523 * @param string $str
2524 * @return bool
2525 */
2528 }
2530 /**
2531 * @param string $str
2532 * @return mixed|string
2533 */
2538 // regexp to find first letter in each word (i.e. after each space)
2539 $replaceRegexp = "/^([a-z]|[\\xc0-\\xff][\\x80-\\xbf]*)| ([a-z]|[\\xc0-\\xff][\\x80-\\xbf]*)/";
2541 // function to use to capitalize a single char
2546 $str
2547 );
2552 $str
2553 );
2554 }
2557 }
2558 }
2560 /**
2561 * capitalize words at word breaks
2562 *
2563 * @param string $str
2564 * @return mixed
2565 */
2570 // since \b doesn't work for UTF-8, we explicitely define word break chars
2573 // find first letter after word break
2581 $str
2582 );
2587 $str
2588 );
2589 }
2594 $str
2595 );
2596 }
2597 }
2599 /**
2600 * Return a case-folded representation of $s
2601 *
2602 * This is a representation such that caseFold($s1)==caseFold($s2) if $s1
2603 * and $s2 are the same except for the case of their characters. It is not
2604 * necessary for the value returned to make sense when displayed.
2605 *
2606 * Do *not* perform any other normalisation in this function. If a caller
2607 * uses this function when it should be using a more general normalisation
2608 * function, then fix the caller.
2609 *
2610 * @param string $s
2611 *
2612 * @return string
2613 */
2616 }
2618 /**
2619 * @param string $s
2620 * @return string
2621 */
2625 }
2628 }
2631 }
2633 /**
2634 * @return array
2635 */
2638 }
2640 /**
2641 * Most writing systems use whitespace to break up words.
2642 * Some languages such as Chinese don't conventionally do this,
2643 * which requires special handling when breaking up words for
2644 * searching etc.
2645 *
2646 * @return bool
2647 */
2650 }
2652 /**
2653 * Some languages such as Chinese require word segmentation,
2654 * Specify such segmentation when overridden in derived class.
2655 *
2656 * @param string $string
2657 * @return string
2658 */
2661 }
2663 /**
2664 * Some languages have special punctuation need to be normalized.
2665 * Make such changes here.
2666 *
2667 * @param string $string
2668 * @return string
2669 */
2672 }
2674 /**
2675 * convert double-width roman characters to single-width.
2676 * range: ff00-ff5f ~= 0020-007f
2677 *
2678 * @param string $string
2679 *
2680 * @return string
2681 */
2691 }
2695 }
2697 /**
2698 * @param string $string
2699 * @param string $pattern
2700 * @return string
2701 */
2706 }
2708 /**
2709 * @param array $termsArray
2710 * @return array
2711 */
2713 # some languages, e.g. Chinese, need to do a conversion
2714 # in order for search results to be displayed correctly
2716 }
2718 /**
2719 * Get the first character of a string.
2720 *
2721 * @param string $s
2722 * @return string
2723 */
2730 $matches
2731 );
2736 }
2738 // Break down Hangul syllables to grab the first jamo
2770 }
2773 }
2774 }
2777 # Some languages may have an alternate char encoding option
2778 # (Esperanto X-coding, Japanese furigana conversion, etc)
2779 # If this language is used as the primary content language,
2780 # an override to the defaults can be set here on startup.
2781 }
2783 /**
2784 * @param string $s
2785 * @return string
2786 */
2788 # For some languages we'll want to explicitly specify
2789 # which characters make it into the edit box raw
2790 # or are converted in some way or another.
2796 }
2797 }
2799 /**
2800 * @param string $s
2801 * @return string
2802 */
2804 # Take the previous into account.
2810 }
2815 }
2816 }
2818 /**
2819 * Convert a UTF-8 string to normal form C. In Malayalam and Arabic, this
2820 * also cleans up certain backwards-compatible sequences, converting them
2821 * to the modern Unicode equivalent.
2822 *
2823 * This is language-specific for performance reasons only.
2824 *
2825 * @param string $s
2826 *
2827 * @return string
2828 */
2835 }
2838 }
2840 /**
2841 * Transform a string using serialized data stored in the given file (which
2842 * must be in the serialized subdirectory of $IP). The file contains pairs
2843 * mapping source characters to destination characters.
2844 *
2845 * The data is cached in process memory. This will go faster if you have the
2846 * FastStringSearch extension.
2847 *
2848 * @param string $file
2849 * @param string $string
2850 *
2851 * @throws MWException
2852 * @return string
2853 */
2859 }
2861 }
2863 }
2865 /**
2866 * For right-to-left language support
2867 *
2868 * @return bool
2869 */
2872 }
2874 /**
2875 * Return the correct HTML 'dir' attribute value for this language.
2876 * @return string
2877 */
2880 }
2882 /**
2883 * Return 'left' or 'right' as appropriate alignment for line-start
2884 * for this language's text direction.
2885 *
2886 * Should be equivalent to CSS3 'start' text-align value....
2887 *
2888 * @return string
2889 */
2892 }
2894 /**
2895 * Return 'right' or 'left' as appropriate alignment for line-end
2896 * for this language's text direction.
2897 *
2898 * Should be equivalent to CSS3 'end' text-align value....
2899 *
2900 * @return string
2901 */
2904 }
2906 /**
2907 * A hidden direction mark (LRM or RLM), depending on the language direction.
2908 * Unlike getDirMark(), this function returns the character as an HTML entity.
2909 * This function should be used when the output is guaranteed to be HTML,
2910 * because it makes the output HTML source code more readable. When
2911 * the output is plain text or can be escaped, getDirMark() should be used.
2912 *
2913 * @param bool $opposite Get the direction mark opposite to your language
2914 * @return string
2915 * @since 1.20
2916 */
2920 }
2922 }
2924 /**
2925 * A hidden direction mark (LRM or RLM), depending on the language direction.
2926 * This function produces them as invisible Unicode characters and
2927 * the output may be hard to read and debug, so it should only be used
2928 * when the output is plain text or can be escaped. When the output is
2929 * HTML, use getDirMarkEntity() instead.
2930 *
2931 * @param bool $opposite Get the direction mark opposite to your language
2932 * @return string
2933 */
2939 }
2941 }
2943 /**
2944 * @return array
2945 */
2948 }
2950 /**
2951 * An arrow, depending on the language direction.
2952 *
2953 * @param string $direction The direction of the arrow: forwards (default),
2954 * backwards, left, right, up, down.
2955 * @return string
2956 */
2971 }
2972 }
2974 /**
2975 * To allow "foo[[bar]]" to extend the link over the whole word "foobar"
2976 *
2977 * @return bool
2978 */
2981 }
2983 /**
2984 * Get all magic words from cache.
2985 * @return array
2986 */
2989 }
2991 /**
2992 * Run the LanguageGetMagic hook once.
2993 */
2997 }
3002 }
3004 /**
3005 * Fill a MagicWord object with data from here
3006 *
3007 * @param MagicWord $mw
3008 */
3010 // Saves a function call
3013 }
3020 }
3027 }
3028 }
3030 /**
3031 * Add magic words to the extension array
3032 *
3033 * @param array $newWords
3034 */
3041 }
3042 }
3043 }
3045 /**
3046 * Get special page names, as an associative array
3047 * case folded alias => real name
3048 * @return array
3049 */
3051 // Cache aliases because it may be slow to load them
3053 // Initialise array
3058 }
3061 }
3063 /**
3064 * Italic is unsuitable for some languages
3065 *
3066 * @param string $text The text to be emphasized.
3067 * @return string
3068 */
3071 }
3073 /**
3074 * Normally we output all numbers in plain en_US style, that is
3075 * 293,291.235 for twohundredninetythreethousand-twohundredninetyone
3076 * point twohundredthirtyfive. However this is not suitable for all
3077 * languages, some such as Punjabi want ੨੯੩,੨੯੫.੨੩੫ and others such as
3078 * Icelandic just want to use commas instead of dots, and dots instead
3079 * of commas like "293.291,235".
3080 *
3081 * An example of this function being called:
3082 * <code>
3083 * wfMessage( 'message' )->numParams( $num )->text()
3084 * </code>
3085 *
3086 * See $separatorTransformTable on MessageIs.php for
3087 * the , => . and . => , implementation.
3088 *
3089 * @todo check if it's viable to use localeconv() for the decimal separator thing.
3090 * @param int|float $number The string to be formatted, should be an integer
3091 * or a floating point number.
3092 * @param bool $nocommafy Set to true for special numbers like dates
3093 * @return string
3094 */
3102 }
3103 }
3109 }
3110 }
3113 }
3115 /**
3116 * Front-end for non-commafied formatNum
3117 *
3118 * @param int|float $number The string to be formatted, should be an integer
3119 * or a floating point number.
3120 * @since 1.21
3121 * @return string
3122 */
3125 }
3127 /**
3128 * @param string $number
3129 * @return string
3130 */
3134 // eliminate empty array values such as ''. (bug 64347)
3137 }
3141 // eliminate empty array values such as ''. (bug 64347)
3144 }
3148 }
3150 /**
3151 * Adds commas to a given number
3152 * @since 1.19
3153 * @param mixed $number
3154 * @return string
3155 */
3160 }
3163 // default grouping is at thousands, use the same for ###,###,### pattern too.
3166 // Ref: http://cldr.unicode.org/translation/number-patterns
3169 // For negative numbers apply the algorithm like positive number and add sign.
3172 }
3180 // the string does not have any number part. Eg: .12345
3182 }
3190 }
3194 // use the last pattern for the rest of the number
3196 }
3199 }
3200 }
3202 }
3203 }
3205 /**
3206 * @return string
3207 */
3210 }
3212 /**
3213 * @return array
3214 */
3217 }
3219 /**
3220 * @return array
3221 */
3224 }
3226 /**
3227 * Take a list of strings and build a locale-friendly comma-separated
3228 * list, using the local comma-separator message.
3229 * The last two strings are chained with an "and".
3230 * NOTE: This function will only work with standard numeric array keys (0, 1, 2…)
3231 *
3232 * @param string[] $l
3233 * @return string
3234 */
3239 }
3245 }
3246 }
3253 }
3254 }
3256 }
3258 /**
3259 * Take a list of strings and build a locale-friendly comma-separated
3260 * list, using the local comma-separator message.
3261 * @param string[] $list Array of strings to put in a comma list
3262 * @return string
3263 */
3267 $list
3268 );
3269 }
3271 /**
3272 * Take a list of strings and build a locale-friendly semicolon-separated
3273 * list, using the local semicolon-separator message.
3274 * @param string[] $list Array of strings to put in a semicolon list
3275 * @return string
3276 */
3280 $list
3281 );
3282 }
3284 /**
3285 * Same as commaList, but separate it with the pipe instead.
3286 * @param string[] $list Array of strings to put in a pipe list
3287 * @return string
3288 */
3292 $list
3293 );
3294 }
3296 /**
3297 * Truncate a string to a specified length in bytes, appending an optional
3298 * string (e.g. for ellipses)
3299 *
3300 * The database offers limited byte lengths for some columns in the database;
3301 * multi-byte character sets mean we need to ensure that only whole characters
3302 * are included, otherwise broken characters can be passed to the user
3303 *
3304 * If $length is negative, the string will be truncated from the beginning
3305 *
3306 * @param string $string String to truncate
3307 * @param int $length Maximum length (including ellipses)
3308 * @param string $ellipsis String to append to the truncated text
3309 * @param bool $adjustLength Subtract length of ellipsis from $length.
3310 * $adjustLength was introduced in 1.18, before that behaved as if false.
3311 * @return string
3312 */
3314 # Use the localized ellipsis character
3317 }
3318 # Check if there is no need to truncate
3323 }
3325 # If ellipsis length is >= $length then we can't apply $adjustLength
3328 # Otherwise, truncate and add ellipsis...
3343 }
3344 }
3345 # Do not truncate if the ellipsis makes the string longer/equal (bug 22181).
3346 # This check is *not* redundant if $adjustLength, due to the single case where
3347 # LEN($ellipsis) > ABS($limit arg); $stringOriginal could be shorter than $string.
3352 }
3353 }
3355 /**
3356 * Remove bytes that represent an incomplete Unicode character
3357 * at the end of string (e.g. bytes of the char are missing)
3358 *
3359 * @param string $string
3360 * @return string
3361 */
3367 # We got the first byte only of a multibyte char; remove it.
3372 ) {
3373 # We chopped in the middle of a character; remove it
3375 }
3376 }
3378 }
3380 /**
3381 * Remove bytes that represent an incomplete Unicode character
3382 * at the start of string (e.g. bytes of the char are missing)
3383 *
3384 * @param string $string
3385 * @return string
3386 */
3391 # We chopped in the middle of a character; remove the whole thing
3393 }
3394 }
3396 }
3398 /**
3399 * Truncate a string of valid HTML to a specified length in bytes,
3400 * appending an optional string (e.g. for ellipses), and return valid HTML
3401 *
3402 * This is only intended for styled/linked text, such as HTML with
3403 * tags like <span> and <a>, were the tags are self-contained (valid HTML).
3404 * Also, this will not detect things like "display:none" CSS.
3405 *
3406 * Note: since 1.18 you do not need to leave extra room in $length for ellipses.
3407 *
3408 * @param string $text HTML string to truncate
3409 * @param int $length (zero/positive) Maximum length (including ellipses)
3410 * @param string $ellipsis String to append to the truncated text
3411 * @return string
3412 */
3414 # Use the localized ellipsis character
3417 }
3418 # Check if there is clearly no need to truncate
3423 }
3437 # Consider truncation once the display length has reached the maximim.
3438 # We check if $dispLen > 0 to grab tags for the $neLength = 0 case.
3439 # Check that we're not in the middle of a bracket/entity...
3443 # Save where we are; we will truncate here unless there turn out to
3444 # be so few remaining characters that truncation is not necessary.
3447 }
3449 # String in fact does need truncation, the truncation point was OK.
3454 }
3455 }
3458 }
3460 # Read the next char...
3478 }
3484 // Name found (e.g. "<a href=..."), add on tag attributes...
3486 }
3492 }
3495 // Save state without $ch. We want to *hit* the first
3496 // display char (to get tags) but not *use* it if truncating.
3498 }
3503 // Add the next $max display text chars after this in one swoop...
3508 }
3509 }
3510 }
3511 }
3512 // Close the last tag if left unclosed by bad HTML
3516 }
3518 }
3520 /**
3521 * truncateHtml() helper function
3522 * like strcspn() but adds the skipped chars to $ret
3523 *
3524 * @param string $ret
3525 * @param string $text
3526 * @param string $search
3527 * @param int $start
3528 * @param null|int $len
3529 * @return int
3530 */
3536 }
3541 }
3543 }
3545 /**
3546 * truncateHtml() helper function
3547 * (a) push or pop $tag from $openTags as needed
3548 * (b) clear $tag value
3549 * @param string &$tag Current HTML tag name we are looking at
3550 * @param int $tagType (0-open tag, 1-close tag)
3551 * @param string $lastCh Character before the '>' that ended this tag
3552 * @param array &$openTags Open tag stack (not accounting for $tag)
3553 */
3562 }
3563 }
3565 }
3566 }
3568 /**
3569 * Grammatical transformations, needed for inflected languages
3570 * Invoked by putting {{grammar:case|word}} in a message
3571 *
3572 * @param string $word
3573 * @param string $case
3574 * @return string
3575 */
3580 }
3583 }
3584 /**
3585 * Get the grammar forms for the content language
3586 * @return array Array of grammar forms
3587 * @since 1.20
3588 */
3593 ) {
3595 }
3598 }
3599 /**
3600 * Provides an alternative text depending on specified gender.
3601 * Usage {{gender:username|masculine|feminine|unknown}}.
3602 * username is optional, in which case the gender of current user is used,
3603 * but only in (some) interface messages; otherwise default gender is used.
3604 *
3605 * If no forms are given, an empty string is returned. If only one form is
3606 * given, it will be returned unconditionally. These details are implied by
3607 * the caller and cannot be overridden in subclasses.
3608 *
3609 * If three forms are given, the default is to use the third (unknown) form.
3610 * If fewer than three forms are given, the default is to use the first (masculine) form.
3611 * These details can be overridden in subclasses.
3612 *
3613 * @param string $gender
3614 * @param array $forms
3615 *
3616 * @return string
3617 */
3621 }
3625 }
3628 }
3630 }
3632 /**
3633 * Plural form transformations, needed for some languages.
3634 * For example, there are 3 form of plural in Russian and Polish,
3635 * depending on "count mod 10". See [[w:Plural]]
3636 * For English it is pretty simple.
3637 *
3638 * Invoked by putting {{plural:count|wordform1|wordform2}}
3639 * or {{plural:count|wordform1|wordform2|wordform3}}
3640 *
3641 * Example: {{plural:{{NUMBEROFARTICLES}}|article|articles}}
3642 *
3643 * @param int $count Non-localized number
3644 * @param array $forms Different plural forms
3645 * @return string Correct form of plural for $count in this language
3646 */
3648 // Handle explicit n=pluralform cases
3652 }
3655 }
3660 }
3662 /**
3663 * Handles explicit plural forms for Language::convertPlural()
3664 *
3665 * In {{PLURAL:$1|0=nothing|one|many}}, 0=nothing will be returned if $1 equals zero.
3666 * If an explicitly defined plural form matches the $count, then
3667 * string value returned, otherwise array returned for further consideration
3668 * by CLDR rules or overridden convertPlural().
3669 *
3670 * @since 1.23
3671 *
3672 * @param int $count non-localized number
3673 * @param array $forms different plural forms
3674 *
3675 * @return array|string
3676 */
3683 }
3685 }
3686 }
3688 }
3690 /**
3691 * Checks that convertPlural was given an array and pads it to requested
3692 * amount of forms by copying the last one.
3693 *
3694 * @param int $count How many forms should there be at least
3695 * @param array $forms Array of forms given to convertPlural
3696 * @return array Padded array of forms or an exception if not an array
3697 */
3701 }
3703 }
3705 /**
3706 * @todo Maybe translate block durations. Note that this function is somewhat misnamed: it
3707 * deals with translating the *duration* ("1 week", "4 days", etc), not the expiry time
3708 * (which is an absolute timestamp). Please note: do NOT add this blindly, as it is used
3709 * on old expiry lengths recorded in log entries. You'd need to provide the start date to
3710 * match up with it.
3711 *
3712 * @param string $str The validated block duration in English
3713 * @return string Somehow translated block duration
3714 * @see LanguageFi.php for example implementation
3715 */
3721 }
3722 }
3724 // Since usually only infinite or indefinite is only on list, so try
3725 // equivalents if still here.
3732 }
3733 }
3734 }
3736 // If all else fails, return a standard duration or timestamp description.
3741 // $time is relative to 0 so it's a duration length.
3745 // wfTimestamp() handles 0 as current time instead of epoch.
3749 }
3750 }
3751 }
3753 /**
3754 * languages like Chinese need to be segmented in order for the diff
3755 * to be of any use
3756 *
3757 * @param string $text
3758 * @return string
3759 */
3762 }
3764 /**
3765 * and unsegment to show the result
3766 *
3767 * @param string $text
3768 * @return string
3769 */
3772 }
3774 /**
3775 * Return the LanguageConverter used in the Language
3776 *
3777 * @since 1.19
3778 * @return LanguageConverter
3779 */
3782 }
3784 /**
3785 * convert text to all supported variants
3786 *
3787 * @param string $text
3788 * @return array
3789 */
3792 }
3794 /**
3795 * convert text to different variants of a language.
3796 *
3797 * @param string $text
3798 * @return string
3799 */
3802 }
3804 /**
3805 * Convert a Title object to a string in the preferred variant
3806 *
3807 * @param Title $title
3808 * @return string
3809 */
3812 }
3814 /**
3815 * Convert a namespace index to a string in the preferred variant
3816 *
3817 * @param int $ns
3818 * @return string
3819 */
3822 }
3824 /**
3825 * Check if this is a language with variants
3826 *
3827 * @return bool
3828 */
3831 }
3833 /**
3834 * Check if the language has the specific variant
3835 *
3836 * @since 1.19
3837 * @param string $variant
3838 * @return bool
3839 */
3842 }
3844 /**
3845 * Put custom tags (e.g. -{ }-) around math to prevent conversion
3846 *
3847 * @param string $text
3848 * @return string
3849 * @deprecated since 1.22 is no longer used
3850 */
3853 }
3855 /**
3856 * Perform output conversion on a string, and encode for safe HTML output.
3857 * @param string $text Text to be converted
3858 * @param bool $isTitle Whether this conversion is for the article title
3859 * @return string
3860 * @todo this should get integrated somewhere sane
3861 */
3864 }
3866 /**
3867 * @param string $key
3868 * @return string
3869 */
3872 }
3874 /**
3875 * Get the list of variants supported by this language
3876 * see sample implementation in LanguageZh.php
3877 *
3878 * @return array an array of language codes
3879 */
3882 }
3884 /**
3885 * @return string
3886 */
3889 }
3891 /**
3892 * @return string
3893 */
3896 }
3898 /**
3899 * @return string
3900 */
3903 }
3905 /**
3906 * If a language supports multiple variants, it is
3907 * possible that non-existing link in one variant
3908 * actually exists in another variant. this function
3909 * tries to find it. See e.g. LanguageZh.php
3910 *
3911 * @param string $link The name of the link
3912 * @param Title $nt The title object of the link
3913 * @param bool $ignoreOtherCond To disable other conditions when
3914 * we need to transclude a template or update a category's link
3915 * @return null the input parameters may be modified upon return
3916 */
3919 }
3921 /**
3922 * returns language specific options used by User::getPageRenderHash()
3923 * for example, the preferred language variant
3924 *
3925 * @return string
3926 */
3929 }
3931 /**
3932 * For languages that support multiple variants, the title of an
3933 * article may be displayed differently in different variants. this
3934 * function returns the apporiate title defined in the body of the article.
3935 *
3936 * @return string
3937 */
3940 }
3942 /**
3943 * Prepare external link text for conversion. When the text is
3944 * a URL, it shouldn't be converted, and it'll be wrapped in
3945 * the "raw" tag (-{R| }-) to prevent conversion.
3946 *
3947 * This function is called "markNoConversion" for historical
3948 * reasons.
3949 *
3950 * @param string $text Text to be used for external link
3951 * @param bool $noParse Wrap it without confirming it's a real URL first
3952 * @return string The tagged text
3953 */
3955 // Excluding protocal-relative URLs may avoid many false positives.
3960 }
3961 }
3963 /**
3964 * A regular expression to match legal word-trailing characters
3965 * which should be merged onto a link of the form [[foo]]bar.
3966 *
3967 * @return string
3968 */
3971 }
3973 /**
3974 * A regular expression character set to match legal word-prefixing
3975 * characters which should be merged onto a link of the form foo[[bar]].
3976 *
3977 * @return string
3978 */
3981 }
3983 /**
3984 * @return Language
3985 */
3988 }
3990 /**
3991 * Get the "parent" language which has a converter to convert a "compatible" language
3992 * (in another variant) to this language (eg. zh for zh-cn, but not en for en-gb).
3993 *
3994 * @return Language|null
3995 * @since 1.22
3996 */
4000 }
4007 }
4012 }
4016 }
4018 /**
4019 * Get the RFC 3066 code for this language object
4020 *
4021 * NOTE: The return value of this function is NOT HTML-safe and must be escaped with
4022 * htmlspecialchars() or similar
4023 *
4024 * @return string
4025 */
4028 }
4030 /**
4031 * Get the code in Bcp47 format which we can use
4032 * inside of html lang="" tags.
4033 *
4034 * NOTE: The return value of this function is NOT HTML-safe and must be escaped with
4035 * htmlspecialchars() or similar.
4036 *
4037 * @since 1.19
4038 * @return string
4039 */
4043 }
4045 }
4047 /**
4048 * @param string $code
4049 */
4052 // Ensure we don't leave incorrect cached data lying around
4055 }
4057 /**
4058 * Get the name of a file for a certain language code
4059 * @param string $prefix Prepend this to the filename
4060 * @param string $code Language code
4061 * @param string $suffix Append this to the filename
4062 * @throws MWException
4063 * @return string $prefix . $mangledCode . $suffix
4064 */
4068 }
4071 }
4073 /**
4074 * Get the language code from a file name. Inverse of getFileName()
4075 * @param string $filename $prefix . $languageCode . $suffix
4076 * @param string $prefix Prefix before the language code
4077 * @param string $suffix Suffix after the language code
4078 * @return string Language code, or false if $prefix or $suffix isn't found
4079 */
4080 public static function getCodeFromFileName( $filename, $prefix = 'Language', $suffix = '.php' ) {
4086 }
4088 }
4090 /**
4091 * @param string $code
4092 * @return string
4093 */
4099 }
4101 /**
4102 * @param string $code
4103 * @return string
4104 * @since 1.23
4105 */
4111 }
4114 }
4116 /**
4117 * @param string $code
4118 * @return string
4119 */
4123 }
4125 /**
4126 * Get the first fallback for a given language.
4127 *
4128 * @param string $code
4129 *
4130 * @return bool|string
4131 */
4139 }
4140 }
4142 /**
4143 * Get the ordered list of fallback languages.
4144 *
4145 * @since 1.19
4146 * @param string $code Language code
4147 * @return array
4148 */
4157 }
4159 }
4160 }
4162 /**
4163 * Get the ordered list of fallback languages, ending with the fallback
4164 * language chain for the site language.
4165 *
4166 * @since 1.22
4167 * @param string $code Language code
4168 * @return array array( fallbacks, site fallbacks )
4169 */
4173 // Usually, we will only store a tiny number of fallback chains, so we
4174 // keep them in static memory.
4180 // Append the site's fallback chain, including the site language itself
4184 // Eliminate any languages already included in the chain
4188 }
4190 }
4192 /**
4193 * Get all messages for a given language
4194 * WARNING: this may take a long time. If you just need all message *keys*
4195 * but need the *contents* of only a few messages, consider using getMessageKeysFor().
4196 *
4197 * @param string $code
4198 *
4199 * @return array
4200 */
4203 }
4205 /**
4206 * Get a message for a given language
4207 *
4208 * @param string $key
4209 * @param string $code
4210 *
4211 * @return string
4212 */
4215 }
4217 /**
4218 * Get all message keys for a given language. This is a faster alternative to
4219 * array_keys( Language::getMessagesFor( $code ) )
4220 *
4221 * @since 1.19
4222 * @param string $code Language code
4223 * @return array of message keys (strings)
4224 */
4227 }
4229 /**
4230 * @param string $talk
4231 * @return mixed
4232 */
4236 }
4241 # Allow grammar transformations
4242 # Allowing full message-style parsing would make simple requests
4243 # such as action=raw much more expensive than they need to be.
4244 # This will hopefully cover most cases.
4248 }
4250 /**
4251 * @param string $m
4252 * @return string
4253 */
4256 }
4258 /**
4259 * @throws MWException
4260 * @return array
4261 */
4266 }
4273 }
4278 }
4280 /**
4281 * Decode an expiry (block, protection, etc) which has come from the DB
4282 *
4283 * @todo FIXME: why are we returnings DBMS-dependent strings???
4284 *
4285 * @param string $expiry Database expiry String
4286 * @param bool|int $format True to process using language functions, or TS_ constant
4287 * to return the expiry in a given timestamp
4288 * @return string
4289 * @since 1.18
4290 */
4295 }
4305 }
4306 }
4308 /**
4309 * @todo Document
4310 * @param int|float $seconds
4311 * @param array $format Optional
4312 * If $format['avoid'] === 'avoidseconds': don't mention seconds if $seconds >= 1 hour.
4313 * If $format['avoid'] === 'avoidminutes': don't mention seconds/minutes if $seconds > 48 hours.
4314 * If $format['noabbrevs'] is true: use 'seconds' and friends instead of 'seconds-abbrev'
4315 * and friends.
4316 * For backwards compatibility, $format may also be one of the strings 'avoidseconds'
4317 * or 'avoidminutes'.
4318 * @return string
4319 */
4323 }
4326 }
4329 }
4351 }
4362 }
4366 }
4372 }
4380 }
4390 }
4394 }
4404 }
4405 }
4407 }
4409 /**
4410 * Format a bitrate for output, using an appropriate
4411 * unit (bps, kbps, Mbps, Gbps, Tbps, Pbps, Ebps, Zbps or Ybps) according to
4412 * the magnitude in question.
4413 *
4414 * This use base 1000. For base 1024 use formatSize(), for another base
4415 * see formatComputingNumbers().
4416 *
4417 * @param int $bps
4418 * @return string
4419 */
4422 }
4424 /**
4425 * @param int $size Size of the unit
4426 * @param int $boundary Size boundary (1000, or 1024 in most cases)
4427 * @param string $messageKey Message key to be uesd
4428 * @return string
4429 */
4434 );
4435 }
4443 }
4445 // For small sizes no decimal places necessary
4448 // For MB and bigger two decimal places are smarter
4450 }
4456 }
4458 /**
4459 * Format a size in bytes for output, using an appropriate
4460 * unit (B, KB, MB, GB, TB, PB, EB, ZB or YB) according to the magnitude in question
4461 *
4462 * This method use base 1024. For base 1000 use formatBitrate(), for
4463 * another base see formatComputingNumbers()
4464 *
4465 * @param int $size Size to format
4466 * @return string Plain text (not HTML)
4467 */
4470 }
4472 /**
4473 * Make a list item, used by various special pages
4474 *
4475 * @param string $page Page link
4476 * @param string $details Text between brackets
4477 * @param bool $oppositedm Add the direction mark opposite to your
4478 * language, to display text properly
4479 * @return string
4480 */
4487 }
4489 /**
4490 * Generate (prev x| next x) (20|50|100...) type links for paging
4491 *
4492 * @param Title $title Title object to link
4493 * @param int $offset
4494 * @param int $limit
4495 * @param array|string $query Optional URL query parameter string
4496 * @param bool $atend Optional param for specified if this is the last page
4497 * @return string
4498 */
4501 ) {
4502 // @todo FIXME: Why on earth this needs one message for the text and another one for tooltip?
4504 # Make 'previous' link
4505 $prev = wfMessage( 'prevn' )->inLanguage( $this )->title( $title )->numParams( $limit )->text();
4511 }
4513 # Make 'next' link
4514 $next = wfMessage( 'nextn' )->inLanguage( $this )->title( $title )->numParams( $limit )->text();
4520 }
4522 # Make links to set number of items per page
4527 }
4531 }
4533 /**
4534 * Helper function for viewPrevNext() that generates links
4535 *
4536 * @param Title $title Title object to link
4537 * @param int $offset
4538 * @param int $limit
4539 * @param array $query Extra query parameters
4540 * @param string $link Text to use for the link; will be escaped
4541 * @param string $tooltipMsg Name of the message to use as tooltip
4542 * @param string $class Value of the "class" attribute of the link
4543 * @return string HTML fragment
4544 */
4547 ) {
4554 }
4556 /**
4557 * Get the conversion rule title, if any.
4558 *
4559 * @return string
4560 */
4563 }
4565 /**
4566 * Get the compiled plural rules for the language
4567 * @since 1.20
4568 * @return array Associative array with plural form, and plural rule as key-value pairs
4569 */
4575 $pluralRules = self::$dataCache->getItem( strtolower( $fallbackCode ), 'compiledPluralRules' );
4578 }
4579 }
4580 }
4582 }
4584 /**
4585 * Get the plural rules for the language
4586 * @since 1.20
4587 * @return array Associative array with plural form number and plural rule as key-value pairs
4588 */
4597 }
4598 }
4599 }
4601 }
4603 /**
4604 * Get the plural rule types for the language
4605 * @since 1.22
4606 * @return array Associative array with plural form number and plural rule type as key-value pairs
4607 */
4613 $pluralRuleTypes = self::$dataCache->getItem( strtolower( $fallbackCode ), 'pluralRuleTypes' );
4616 }
4617 }
4618 }
4620 }
4622 /**
4623 * Find the index number of the plural rule appropriate for the given number
4624 * @return int The index number of the plural rule
4625 */
4630 }
4632 /**
4633 * Find the plural rule type appropriate for the given number
4634 * For example, if the language is set to Arabic, getPluralType(5) should
4635 * return 'few'.
4636 * @since 1.22
4637 * @return string The name of the plural rule type, e.g. one, two, few, many
4638 */
4646 }
4647 }
4648 }