3 * Internationalisation code
10 * @defgroup Language Language
13 if ( !defined( 'MEDIAWIKI' ) ) {
14 echo "This file is part of MediaWiki, it is not a valid entry point.\n";
19 global $wgLanguageNames;
20 require_once( dirname( __FILE__
) . '/Names.php' );
22 if ( function_exists( 'mb_strtoupper' ) ) {
23 mb_internal_encoding( 'UTF-8' );
27 * a fake language converter
33 function __construct( $langobj ) { $this->mLang
= $langobj; }
34 function autoConvertToAllVariants( $text ) { return array( $this->mLang
->getCode() => $text ); }
35 function convert( $t ) { return $t; }
36 function convertTitle( $t ) { return $t->getPrefixedText(); }
37 function getVariants() { return array( $this->mLang
->getCode() ); }
38 function getPreferredVariant() { return $this->mLang
->getCode(); }
39 function getDefaultVariant() { return $this->mLang
->getCode(); }
40 function getURLVariant() { return ''; }
41 function getConvRuleTitle() { return false; }
42 function findVariantLink( &$l, &$n, $ignoreOtherCond = false ) { }
43 function getExtraHashOptions() { return ''; }
44 function getParsedTitle() { return ''; }
45 function markNoConversion( $text, $noParse = false ) { return $text; }
46 function convertCategoryKey( $key ) { return $key; }
47 function convertLinkToAllVariants( $text ) { return $this->autoConvertToAllVariants( $text ); }
48 function armourMath( $text ) { return $text; }
52 * Internationalisation code
58 * @var LanguageConverter
62 var $mVariants, $mCode, $mLoaded = false;
63 var $mMagicExtensions = array(), $mMagicHookDone = false;
65 var $mNamespaceIds, $namespaceNames, $namespaceAliases;
66 var $dateFormatStrings = array();
67 var $mExtendedSpecialPageAliases;
70 * ReplacementArray object caches
72 var $transformData = array();
75 * @var LocalisationCache
77 static public $dataCache;
79 static public $mLangObjCache = array();
81 static public $mWeekdayMsgs = array(
82 'sunday', 'monday', 'tuesday', 'wednesday', 'thursday',
86 static public $mWeekdayAbbrevMsgs = array(
87 'sun', 'mon', 'tue', 'wed', 'thu', 'fri', 'sat'
90 static public $mMonthMsgs = array(
91 'january', 'february', 'march', 'april', 'may_long', 'june',
92 'july', 'august', 'september', 'october', 'november',
95 static public $mMonthGenMsgs = array(
96 'january-gen', 'february-gen', 'march-gen', 'april-gen', 'may-gen', 'june-gen',
97 'july-gen', 'august-gen', 'september-gen', 'october-gen', 'november-gen',
100 static public $mMonthAbbrevMsgs = array(
101 'jan', 'feb', 'mar', 'apr', 'may', 'jun', 'jul', 'aug',
102 'sep', 'oct', 'nov', 'dec'
105 static public $mIranianCalendarMonthMsgs = array(
106 'iranian-calendar-m1', 'iranian-calendar-m2', 'iranian-calendar-m3',
107 'iranian-calendar-m4', 'iranian-calendar-m5', 'iranian-calendar-m6',
108 'iranian-calendar-m7', 'iranian-calendar-m8', 'iranian-calendar-m9',
109 'iranian-calendar-m10', 'iranian-calendar-m11', 'iranian-calendar-m12'
112 static public $mHebrewCalendarMonthMsgs = array(
113 'hebrew-calendar-m1', 'hebrew-calendar-m2', 'hebrew-calendar-m3',
114 'hebrew-calendar-m4', 'hebrew-calendar-m5', 'hebrew-calendar-m6',
115 'hebrew-calendar-m7', 'hebrew-calendar-m8', 'hebrew-calendar-m9',
116 'hebrew-calendar-m10', 'hebrew-calendar-m11', 'hebrew-calendar-m12',
117 'hebrew-calendar-m6a', 'hebrew-calendar-m6b'
120 static public $mHebrewCalendarMonthGenMsgs = array(
121 'hebrew-calendar-m1-gen', 'hebrew-calendar-m2-gen', 'hebrew-calendar-m3-gen',
122 'hebrew-calendar-m4-gen', 'hebrew-calendar-m5-gen', 'hebrew-calendar-m6-gen',
123 'hebrew-calendar-m7-gen', 'hebrew-calendar-m8-gen', 'hebrew-calendar-m9-gen',
124 'hebrew-calendar-m10-gen', 'hebrew-calendar-m11-gen', 'hebrew-calendar-m12-gen',
125 'hebrew-calendar-m6a-gen', 'hebrew-calendar-m6b-gen'
128 static public $mHijriCalendarMonthMsgs = array(
129 'hijri-calendar-m1', 'hijri-calendar-m2', 'hijri-calendar-m3',
130 'hijri-calendar-m4', 'hijri-calendar-m5', 'hijri-calendar-m6',
131 'hijri-calendar-m7', 'hijri-calendar-m8', 'hijri-calendar-m9',
132 'hijri-calendar-m10', 'hijri-calendar-m11', 'hijri-calendar-m12'
136 * Get a cached language object for a given language code
137 * @param $code String
140 static function factory( $code ) {
141 if ( !isset( self
::$mLangObjCache[$code] ) ) {
142 if ( count( self
::$mLangObjCache ) > 10 ) {
143 // Don't keep a billion objects around, that's stupid.
144 self
::$mLangObjCache = array();
146 self
::$mLangObjCache[$code] = self
::newFromCode( $code );
148 return self
::$mLangObjCache[$code];
152 * Create a language object for a given language code
153 * @param $code String
156 protected static function newFromCode( $code ) {
157 // Protect against path traversal below
158 if ( !Language
::isValidCode( $code )
159 ||
strcspn( $code, ":/\\\000" ) !== strlen( $code ) )
161 throw new MWException( "Invalid language code \"$code\"" );
164 if ( !Language
::isValidBuiltInCode( $code ) ) {
165 // It's not possible to customise this code with class files, so
166 // just return a Language object. This is to support uselang= hacks.
167 $lang = new Language
;
168 $lang->setCode( $code );
172 // Check if there is a language class for the code
173 $class = self
::classFromCode( $code );
174 self
::preloadLanguageClass( $class );
175 if ( MWInit
::classExists( $class ) ) {
180 // Keep trying the fallback list until we find an existing class
181 $fallbacks = Language
::getFallbacksFor( $code );
182 foreach ( $fallbacks as $fallbackCode ) {
183 if ( !Language
::isValidBuiltInCode( $fallbackCode ) ) {
184 throw new MWException( "Invalid fallback '$fallbackCode' in fallback sequence for '$code'" );
187 $class = self
::classFromCode( $fallbackCode );
188 self
::preloadLanguageClass( $class );
189 if ( MWInit
::classExists( $class ) ) {
190 $lang = Language
::newFromCode( $fallbackCode );
191 $lang->setCode( $code );
196 throw new MWException( "Invalid fallback sequence for language '$code'" );
200 * Returns true if a language code string is of a valid form, whether or
201 * not it exists. This includes codes which are used solely for
202 * customisation via the MediaWiki namespace.
204 * @param $code string
208 public static function isValidCode( $code ) {
210 strcspn( $code, ":/\\\000" ) === strlen( $code )
211 && !preg_match( Title
::getTitleInvalidRegex(), $code );
215 * Returns true if a language code is of a valid form for the purposes of
216 * internal customisation of MediaWiki, via Messages*.php.
218 * @param $code string
223 public static function isValidBuiltInCode( $code ) {
224 return preg_match( '/^[a-z0-9-]+$/i', $code );
229 * @return String Name of the language class
231 public static function classFromCode( $code ) {
232 if ( $code == 'en' ) {
235 return 'Language' . str_replace( '-', '_', ucfirst( $code ) );
240 * Includes language class files
242 * @param $class Name of the language class
244 public static function preloadLanguageClass( $class ) {
247 if ( $class === 'Language' ) {
251 if ( !defined( 'MW_COMPILED' ) ) {
252 // Preload base classes to work around APC/PHP5 bug
253 if ( file_exists( "$IP/languages/classes/$class.deps.php" ) ) {
254 include_once( "$IP/languages/classes/$class.deps.php" );
256 if ( file_exists( "$IP/languages/classes/$class.php" ) ) {
257 include_once( "$IP/languages/classes/$class.php" );
263 * Get the LocalisationCache instance
265 * @return LocalisationCache
267 public static function getLocalisationCache() {
268 if ( is_null( self
::$dataCache ) ) {
269 global $wgLocalisationCacheConf;
270 $class = $wgLocalisationCacheConf['class'];
271 self
::$dataCache = new $class( $wgLocalisationCacheConf );
273 return self
::$dataCache;
276 function __construct() {
277 $this->mConverter
= new FakeConverter( $this );
278 // Set the code to the name of the descendant
279 if ( get_class( $this ) == 'Language' ) {
282 $this->mCode
= str_replace( '_', '-', strtolower( substr( get_class( $this ), 8 ) ) );
284 self
::getLocalisationCache();
288 * Reduce memory usage
290 function __destruct() {
291 foreach ( $this as $name => $value ) {
292 unset( $this->$name );
297 * Hook which will be called if this is the content language.
298 * Descendants can use this to register hook functions or modify globals
300 function initContLang() { }
303 * Same as getFallbacksFor for current language.
305 * @deprecated in 1.19
307 function getFallbackLanguageCode() {
308 wfDeprecated( __METHOD__
);
309 return self
::getFallbackFor( $this->mCode
);
316 function getFallbackLanguages() {
317 return self
::getFallbacksFor( $this->mCode
);
321 * Exports $wgBookstoreListEn
324 function getBookstoreList() {
325 return self
::$dataCache->getItem( $this->mCode
, 'bookstoreList' );
331 function getNamespaces() {
332 if ( is_null( $this->namespaceNames
) ) {
333 global $wgMetaNamespace, $wgMetaNamespaceTalk, $wgExtraNamespaces;
335 $this->namespaceNames
= self
::$dataCache->getItem( $this->mCode
, 'namespaceNames' );
336 $validNamespaces = MWNamespace
::getCanonicalNamespaces();
338 $this->namespaceNames
= $wgExtraNamespaces +
$this->namespaceNames +
$validNamespaces;
340 $this->namespaceNames
[NS_PROJECT
] = $wgMetaNamespace;
341 if ( $wgMetaNamespaceTalk ) {
342 $this->namespaceNames
[NS_PROJECT_TALK
] = $wgMetaNamespaceTalk;
344 $talk = $this->namespaceNames
[NS_PROJECT_TALK
];
345 $this->namespaceNames
[NS_PROJECT_TALK
] =
346 $this->fixVariableInNamespace( $talk );
349 # Sometimes a language will be localised but not actually exist on this wiki.
350 foreach ( $this->namespaceNames
as $key => $text ) {
351 if ( !isset( $validNamespaces[$key] ) ) {
352 unset( $this->namespaceNames
[$key] );
356 # The above mixing may leave namespaces out of canonical order.
357 # Re-order by namespace ID number...
358 ksort( $this->namespaceNames
);
360 wfRunHooks( 'LanguageGetNamespaces', array( &$this->namespaceNames
) );
362 return $this->namespaceNames
;
366 * A convenience function that returns the same thing as
367 * getNamespaces() except with the array values changed to ' '
368 * where it found '_', useful for producing output to be displayed
369 * e.g. in <select> forms.
373 function getFormattedNamespaces() {
374 $ns = $this->getNamespaces();
375 foreach ( $ns as $k => $v ) {
376 $ns[$k] = strtr( $v, '_', ' ' );
382 * Get a namespace value by key
384 * $mw_ns = $wgContLang->getNsText( NS_MEDIAWIKI );
385 * echo $mw_ns; // prints 'MediaWiki'
388 * @param $index Int: the array key of the namespace to return
389 * @return mixed, string if the namespace value exists, otherwise false
391 function getNsText( $index ) {
392 $ns = $this->getNamespaces();
393 return isset( $ns[$index] ) ?
$ns[$index] : false;
397 * A convenience function that returns the same thing as
398 * getNsText() except with '_' changed to ' ', useful for
401 * @param $index string
405 function getFormattedNsText( $index ) {
406 $ns = $this->getNsText( $index );
407 return strtr( $ns, '_', ' ' );
411 * Returns gender-dependent namespace alias if available.
412 * @param $index Int: namespace index
413 * @param $gender String: gender key (male, female... )
417 function getGenderNsText( $index, $gender ) {
418 global $wgExtraGenderNamespaces;
420 $ns = $wgExtraGenderNamespaces + self
::$dataCache->getItem( $this->mCode
, 'namespaceGenderAliases' );
421 return isset( $ns[$index][$gender] ) ?
$ns[$index][$gender] : $this->getNsText( $index );
425 * Whether this language makes distinguishes genders for example in
430 function needsGenderDistinction() {
431 global $wgExtraGenderNamespaces, $wgExtraNamespaces;
432 if ( count( $wgExtraGenderNamespaces ) > 0 ) {
433 // $wgExtraGenderNamespaces overrides everything
435 } elseif ( isset( $wgExtraNamespaces[NS_USER
] ) && isset( $wgExtraNamespaces[NS_USER_TALK
] ) ) {
436 /// @todo There may be other gender namespace than NS_USER & NS_USER_TALK in the future
437 // $wgExtraNamespaces overrides any gender aliases specified in i18n files
440 // Check what is in i18n files
441 $aliases = self
::$dataCache->getItem( $this->mCode
, 'namespaceGenderAliases' );
442 return count( $aliases ) > 0;
447 * Get a namespace key by value, case insensitive.
448 * Only matches namespace names for the current language, not the
449 * canonical ones defined in Namespace.php.
451 * @param $text String
452 * @return mixed An integer if $text is a valid value otherwise false
454 function getLocalNsIndex( $text ) {
455 $lctext = $this->lc( $text );
456 $ids = $this->getNamespaceIds();
457 return isset( $ids[$lctext] ) ?
$ids[$lctext] : false;
463 function getNamespaceAliases() {
464 if ( is_null( $this->namespaceAliases
) ) {
465 $aliases = self
::$dataCache->getItem( $this->mCode
, 'namespaceAliases' );
469 foreach ( $aliases as $name => $index ) {
470 if ( $index === NS_PROJECT_TALK
) {
471 unset( $aliases[$name] );
472 $name = $this->fixVariableInNamespace( $name );
473 $aliases[$name] = $index;
478 global $wgExtraGenderNamespaces;
479 $genders = $wgExtraGenderNamespaces + self
::$dataCache->getItem( $this->mCode
, 'namespaceGenderAliases' );
480 foreach ( $genders as $index => $forms ) {
481 foreach ( $forms as $alias ) {
482 $aliases[$alias] = $index;
486 $this->namespaceAliases
= $aliases;
488 return $this->namespaceAliases
;
494 function getNamespaceIds() {
495 if ( is_null( $this->mNamespaceIds
) ) {
496 global $wgNamespaceAliases;
497 # Put namespace names and aliases into a hashtable.
498 # If this is too slow, then we should arrange it so that it is done
499 # before caching. The catch is that at pre-cache time, the above
500 # class-specific fixup hasn't been done.
501 $this->mNamespaceIds
= array();
502 foreach ( $this->getNamespaces() as $index => $name ) {
503 $this->mNamespaceIds
[$this->lc( $name )] = $index;
505 foreach ( $this->getNamespaceAliases() as $name => $index ) {
506 $this->mNamespaceIds
[$this->lc( $name )] = $index;
508 if ( $wgNamespaceAliases ) {
509 foreach ( $wgNamespaceAliases as $name => $index ) {
510 $this->mNamespaceIds
[$this->lc( $name )] = $index;
514 return $this->mNamespaceIds
;
518 * Get a namespace key by value, case insensitive. Canonical namespace
519 * names override custom ones defined for the current language.
521 * @param $text String
522 * @return mixed An integer if $text is a valid value otherwise false
524 function getNsIndex( $text ) {
525 $lctext = $this->lc( $text );
526 $ns = MWNamespace
::getCanonicalIndex( $lctext );
527 if ( $ns !== null ) {
530 $ids = $this->getNamespaceIds();
531 return isset( $ids[$lctext] ) ?
$ids[$lctext] : false;
535 * short names for language variants used for language conversion links.
537 * @param $code String
538 * @param $usemsg bool Use the "variantname-xyz" message if it exists
541 function getVariantname( $code, $usemsg = true ) {
542 $msg = "variantname-$code";
543 list( $rootCode ) = explode( '-', $code );
544 if ( $usemsg && wfMessage( $msg )->exists() ) {
545 return $this->getMessageFromDB( $msg );
547 $name = self
::getLanguageName( $code );
549 return $name; # if it's defined as a language name, show that
551 # otherwise, output the language code
557 * @param $name string
560 function specialPage( $name ) {
561 $aliases = $this->getSpecialPageAliases();
562 if ( isset( $aliases[$name][0] ) ) {
563 $name = $aliases[$name][0];
565 return $this->getNsText( NS_SPECIAL
) . ':' . $name;
571 function getQuickbarSettings() {
573 $this->getMessage( 'qbsettings-none' ),
574 $this->getMessage( 'qbsettings-fixedleft' ),
575 $this->getMessage( 'qbsettings-fixedright' ),
576 $this->getMessage( 'qbsettings-floatingleft' ),
577 $this->getMessage( 'qbsettings-floatingright' ),
578 $this->getMessage( 'qbsettings-directionality' )
585 function getDatePreferences() {
586 return self
::$dataCache->getItem( $this->mCode
, 'datePreferences' );
592 function getDateFormats() {
593 return self
::$dataCache->getItem( $this->mCode
, 'dateFormats' );
597 * @return array|string
599 function getDefaultDateFormat() {
600 $df = self
::$dataCache->getItem( $this->mCode
, 'defaultDateFormat' );
601 if ( $df === 'dmy or mdy' ) {
602 global $wgAmericanDates;
603 return $wgAmericanDates ?
'mdy' : 'dmy';
612 function getDatePreferenceMigrationMap() {
613 return self
::$dataCache->getItem( $this->mCode
, 'datePreferenceMigrationMap' );
620 function getImageFile( $image ) {
621 return self
::$dataCache->getSubitem( $this->mCode
, 'imageFiles', $image );
627 function getExtraUserToggles() {
628 return self
::$dataCache->getItem( $this->mCode
, 'extraUserToggles' );
635 function getUserToggle( $tog ) {
636 return $this->getMessageFromDB( "tog-$tog" );
640 * Get language names, indexed by code.
641 * If $customisedOnly is true, only returns codes with a messages file
643 * @param $customisedOnly bool
647 public static function getLanguageNames( $customisedOnly = false ) {
648 global $wgExtraLanguageNames;
649 static $coreLanguageNames;
651 if ( $coreLanguageNames === null ) {
652 include( MWInit
::compiledPath( 'languages/Names.php' ) );
655 $allNames = $wgExtraLanguageNames +
$coreLanguageNames;
656 if ( !$customisedOnly ) {
662 $dir = opendir( "$IP/languages/messages" );
663 while ( false !== ( $file = readdir( $dir ) ) ) {
664 $code = self
::getCodeFromFileName( $file, 'Messages' );
665 if ( $code && isset( $allNames[$code] ) ) {
666 $names[$code] = $allNames[$code];
674 * Get translated language names. This is done on best effort and
675 * by default this is exactly the same as Language::getLanguageNames.
676 * The CLDR extension provides translated names.
677 * @param $code String Language code.
678 * @return Array language code => language name
681 public static function getTranslatedLanguageNames( $code ) {
683 wfRunHooks( 'LanguageGetTranslatedLanguageNames', array( &$names, $code ) );
685 foreach ( self
::getLanguageNames() as $code => $name ) {
686 if ( !isset( $names[$code] ) ) $names[$code] = $name;
693 * Get a message from the MediaWiki namespace.
695 * @param $msg String: message name
698 function getMessageFromDB( $msg ) {
699 return wfMsgExt( $msg, array( 'parsemag', 'language' => $this ) );
703 * @param $code string
706 function getLanguageName( $code ) {
707 $names = self
::getLanguageNames();
708 if ( !array_key_exists( $code, $names ) ) {
711 return $names[$code];
718 function getMonthName( $key ) {
719 return $this->getMessageFromDB( self
::$mMonthMsgs[$key - 1] );
725 function getMonthNamesArray() {
726 $monthNames = array( '' );
727 for ( $i = 1; $i < 13; $i++
) {
728 $monthNames[] = $this->getMonthName( $i );
737 function getMonthNameGen( $key ) {
738 return $this->getMessageFromDB( self
::$mMonthGenMsgs[$key - 1] );
745 function getMonthAbbreviation( $key ) {
746 return $this->getMessageFromDB( self
::$mMonthAbbrevMsgs[$key - 1] );
752 function getMonthAbbreviationsArray() {
753 $monthNames = array( '' );
754 for ( $i = 1; $i < 13; $i++
) {
755 $monthNames[] = $this->getMonthAbbreviation( $i );
764 function getWeekdayName( $key ) {
765 return $this->getMessageFromDB( self
::$mWeekdayMsgs[$key - 1] );
772 function getWeekdayAbbreviation( $key ) {
773 return $this->getMessageFromDB( self
::$mWeekdayAbbrevMsgs[$key - 1] );
780 function getIranianCalendarMonthName( $key ) {
781 return $this->getMessageFromDB( self
::$mIranianCalendarMonthMsgs[$key - 1] );
788 function getHebrewCalendarMonthName( $key ) {
789 return $this->getMessageFromDB( self
::$mHebrewCalendarMonthMsgs[$key - 1] );
796 function getHebrewCalendarMonthNameGen( $key ) {
797 return $this->getMessageFromDB( self
::$mHebrewCalendarMonthGenMsgs[$key - 1] );
804 function getHijriCalendarMonthName( $key ) {
805 return $this->getMessageFromDB( self
::$mHijriCalendarMonthMsgs[$key - 1] );
809 * Used by date() and time() to adjust the time output.
811 * @param $ts Int the time in date('YmdHis') format
812 * @param $tz Mixed: adjust the time by this amount (default false, mean we
813 * get user timecorrection setting)
816 function userAdjust( $ts, $tz = false ) {
817 global $wgUser, $wgLocalTZoffset;
819 if ( $tz === false ) {
820 $tz = $wgUser->getOption( 'timecorrection' );
823 $data = explode( '|', $tz, 3 );
825 if ( $data[0] == 'ZoneInfo' ) {
826 wfSuppressWarnings();
827 $userTZ = timezone_open( $data[2] );
829 if ( $userTZ !== false ) {
830 $date = date_create( $ts, timezone_open( 'UTC' ) );
831 date_timezone_set( $date, $userTZ );
832 $date = date_format( $date, 'YmdHis' );
835 # Unrecognized timezone, default to 'Offset' with the stored offset.
840 if ( $data[0] == 'System' ||
$tz == '' ) {
841 # Global offset in minutes.
842 if ( isset( $wgLocalTZoffset ) ) {
843 $minDiff = $wgLocalTZoffset;
845 } elseif ( $data[0] == 'Offset' ) {
846 $minDiff = intval( $data[1] );
848 $data = explode( ':', $tz );
849 if ( count( $data ) == 2 ) {
850 $data[0] = intval( $data[0] );
851 $data[1] = intval( $data[1] );
852 $minDiff = abs( $data[0] ) * 60 +
$data[1];
853 if ( $data[0] < 0 ) {
854 $minDiff = -$minDiff;
857 $minDiff = intval( $data[0] ) * 60;
861 # No difference ? Return time unchanged
862 if ( 0 == $minDiff ) {
866 wfSuppressWarnings(); // E_STRICT system time bitching
867 # Generate an adjusted date; take advantage of the fact that mktime
868 # will normalize out-of-range values so we don't have to split $minDiff
869 # into hours and minutes.
871 (int)substr( $ts, 8, 2 ) ), # Hours
872 (int)substr( $ts, 10, 2 ) +
$minDiff, # Minutes
873 (int)substr( $ts, 12, 2 ), # Seconds
874 (int)substr( $ts, 4, 2 ), # Month
875 (int)substr( $ts, 6, 2 ), # Day
876 (int)substr( $ts, 0, 4 ) ); # Year
878 $date = date( 'YmdHis', $t );
885 * This is a workalike of PHP's date() function, but with better
886 * internationalisation, a reduced set of format characters, and a better
889 * Supported format characters are dDjlNwzWFmMntLoYyaAgGhHiscrU. See the
890 * PHP manual for definitions. There are a number of extensions, which
893 * xn Do not translate digits of the next numeric format character
894 * xN Toggle raw digit (xn) flag, stays set until explicitly unset
895 * xr Use roman numerals for the next numeric format character
896 * xh Use hebrew numerals for the next numeric format character
898 * xg Genitive month name
900 * xij j (day number) in Iranian calendar
901 * xiF F (month name) in Iranian calendar
902 * xin n (month number) in Iranian calendar
903 * xiY Y (full year) in Iranian calendar
905 * xjj j (day number) in Hebrew calendar
906 * xjF F (month name) in Hebrew calendar
907 * xjt t (days in month) in Hebrew calendar
908 * xjx xg (genitive month name) in Hebrew calendar
909 * xjn n (month number) in Hebrew calendar
910 * xjY Y (full year) in Hebrew calendar
912 * xmj j (day number) in Hijri calendar
913 * xmF F (month name) in Hijri calendar
914 * xmn n (month number) in Hijri calendar
915 * xmY Y (full year) in Hijri calendar
917 * xkY Y (full year) in Thai solar calendar. Months and days are
918 * identical to the Gregorian calendar
919 * xoY Y (full year) in Minguo calendar or Juche year.
920 * Months and days are identical to the
922 * xtY Y (full year) in Japanese nengo. Months and days are
923 * identical to the Gregorian calendar
925 * Characters enclosed in double quotes will be considered literal (with
926 * the quotes themselves removed). Unmatched quotes will be considered
927 * literal quotes. Example:
929 * "The month is" F => The month is January
932 * Backslash escaping is also supported.
934 * Input timestamp is assumed to be pre-normalized to the desired local
937 * @param $format String
938 * @param $ts String: 14-character timestamp
941 * @todo handling of "o" format character for Iranian, Hebrew, Hijri & Thai?
945 function sprintfDate( $format, $ts ) {
958 for ( $p = 0; $p < strlen( $format ); $p++
) {
961 if ( $code == 'x' && $p < strlen( $format ) - 1 ) {
962 $code .= $format[++
$p];
965 if ( ( $code === 'xi' ||
$code == 'xj' ||
$code == 'xk' ||
$code == 'xm' ||
$code == 'xo' ||
$code == 'xt' ) && $p < strlen( $format ) - 1 ) {
966 $code .= $format[++
$p];
977 $rawToggle = !$rawToggle;
986 $s .= $this->getMonthNameGen( substr( $ts, 4, 2 ) );
989 if ( !$hebrew ) $hebrew = self
::tsToHebrew( $ts );
990 $s .= $this->getHebrewCalendarMonthNameGen( $hebrew[1] );
993 $num = substr( $ts, 6, 2 );
996 if ( !$unix ) $unix = wfTimestamp( TS_UNIX
, $ts );
997 $s .= $this->getWeekdayAbbreviation( gmdate( 'w', $unix ) +
1 );
1000 $num = intval( substr( $ts, 6, 2 ) );
1004 $iranian = self
::tsToIranian( $ts );
1010 $hijri = self
::tsToHijri( $ts );
1016 $hebrew = self
::tsToHebrew( $ts );
1022 $unix = wfTimestamp( TS_UNIX
, $ts );
1024 $s .= $this->getWeekdayName( gmdate( 'w', $unix ) +
1 );
1028 $unix = wfTimestamp( TS_UNIX
, $ts );
1030 $w = gmdate( 'w', $unix );
1035 $unix = wfTimestamp( TS_UNIX
, $ts );
1037 $num = gmdate( 'w', $unix );
1041 $unix = wfTimestamp( TS_UNIX
, $ts );
1043 $num = gmdate( 'z', $unix );
1047 $unix = wfTimestamp( TS_UNIX
, $ts );
1049 $num = gmdate( 'W', $unix );
1052 $s .= $this->getMonthName( substr( $ts, 4, 2 ) );
1056 $iranian = self
::tsToIranian( $ts );
1058 $s .= $this->getIranianCalendarMonthName( $iranian[1] );
1062 $hijri = self
::tsToHijri( $ts );
1064 $s .= $this->getHijriCalendarMonthName( $hijri[1] );
1068 $hebrew = self
::tsToHebrew( $ts );
1070 $s .= $this->getHebrewCalendarMonthName( $hebrew[1] );
1073 $num = substr( $ts, 4, 2 );
1076 $s .= $this->getMonthAbbreviation( substr( $ts, 4, 2 ) );
1079 $num = intval( substr( $ts, 4, 2 ) );
1083 $iranian = self
::tsToIranian( $ts );
1089 $hijri = self
::tsToHijri ( $ts );
1095 $hebrew = self
::tsToHebrew( $ts );
1101 $unix = wfTimestamp( TS_UNIX
, $ts );
1103 $num = gmdate( 't', $unix );
1107 $hebrew = self
::tsToHebrew( $ts );
1113 $unix = wfTimestamp( TS_UNIX
, $ts );
1115 $num = gmdate( 'L', $unix );
1119 $unix = wfTimestamp( TS_UNIX
, $ts );
1121 $num = date( 'o', $unix );
1124 $num = substr( $ts, 0, 4 );
1128 $iranian = self
::tsToIranian( $ts );
1134 $hijri = self
::tsToHijri( $ts );
1140 $hebrew = self
::tsToHebrew( $ts );
1146 $thai = self
::tsToYear( $ts, 'thai' );
1152 $minguo = self
::tsToYear( $ts, 'minguo' );
1158 $tenno = self
::tsToYear( $ts, 'tenno' );
1163 $num = substr( $ts, 2, 2 );
1166 $s .= intval( substr( $ts, 8, 2 ) ) < 12 ?
'am' : 'pm';
1169 $s .= intval( substr( $ts, 8, 2 ) ) < 12 ?
'AM' : 'PM';
1172 $h = substr( $ts, 8, 2 );
1173 $num = $h %
12 ?
$h %
12 : 12;
1176 $num = intval( substr( $ts, 8, 2 ) );
1179 $h = substr( $ts, 8, 2 );
1180 $num = sprintf( '%02d', $h %
12 ?
$h %
12 : 12 );
1183 $num = substr( $ts, 8, 2 );
1186 $num = substr( $ts, 10, 2 );
1189 $num = substr( $ts, 12, 2 );
1193 $unix = wfTimestamp( TS_UNIX
, $ts );
1195 $s .= gmdate( 'c', $unix );
1199 $unix = wfTimestamp( TS_UNIX
, $ts );
1201 $s .= gmdate( 'r', $unix );
1205 $unix = wfTimestamp( TS_UNIX
, $ts );
1210 # Backslash escaping
1211 if ( $p < strlen( $format ) - 1 ) {
1212 $s .= $format[++
$p];
1219 if ( $p < strlen( $format ) - 1 ) {
1220 $endQuote = strpos( $format, '"', $p +
1 );
1221 if ( $endQuote === false ) {
1222 # No terminating quote, assume literal "
1225 $s .= substr( $format, $p +
1, $endQuote - $p - 1 );
1229 # Quote at end of string, assume literal "
1236 if ( $num !== false ) {
1237 if ( $rawToggle ||
$raw ) {
1240 } elseif ( $roman ) {
1241 $s .= self
::romanNumeral( $num );
1243 } elseif ( $hebrewNum ) {
1244 $s .= self
::hebrewNumeral( $num );
1247 $s .= $this->formatNum( $num, true );
1254 private static $GREG_DAYS = array( 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 );
1255 private static $IRANIAN_DAYS = array( 31, 31, 31, 31, 31, 31, 30, 30, 30, 30, 30, 29 );
1258 * Algorithm by Roozbeh Pournader and Mohammad Toossi to convert
1259 * Gregorian dates to Iranian dates. Originally written in C, it
1260 * is released under the terms of GNU Lesser General Public
1261 * License. Conversion to PHP was performed by Niklas Laxström.
1263 * Link: http://www.farsiweb.info/jalali/jalali.c
1269 private static function tsToIranian( $ts ) {
1270 $gy = substr( $ts, 0, 4 ) -1600;
1271 $gm = substr( $ts, 4, 2 ) -1;
1272 $gd = substr( $ts, 6, 2 ) -1;
1274 # Days passed from the beginning (including leap years)
1276 +
floor( ( $gy +
3 ) / 4 )
1277 - floor( ( $gy +
99 ) / 100 )
1278 +
floor( ( $gy +
399 ) / 400 );
1280 // Add days of the past months of this year
1281 for ( $i = 0; $i < $gm; $i++
) {
1282 $gDayNo +
= self
::$GREG_DAYS[$i];
1286 if ( $gm > 1 && ( ( $gy %
4 === 0 && $gy %
100 !== 0 ||
( $gy %
400 == 0 ) ) ) ) {
1290 // Days passed in current month
1293 $jDayNo = $gDayNo - 79;
1295 $jNp = floor( $jDayNo / 12053 );
1298 $jy = 979 +
33 * $jNp +
4 * floor( $jDayNo / 1461 );
1301 if ( $jDayNo >= 366 ) {
1302 $jy +
= floor( ( $jDayNo - 1 ) / 365 );
1303 $jDayNo = floor( ( $jDayNo - 1 ) %
365 );
1306 for ( $i = 0; $i < 11 && $jDayNo >= self
::$IRANIAN_DAYS[$i]; $i++
) {
1307 $jDayNo -= self
::$IRANIAN_DAYS[$i];
1313 return array( $jy, $jm, $jd );
1317 * Converting Gregorian dates to Hijri dates.
1319 * Based on a PHP-Nuke block by Sharjeel which is released under GNU/GPL license
1321 * @link http://phpnuke.org/modules.php?name=News&file=article&sid=8234&mode=thread&order=0&thold=0
1327 private static function tsToHijri( $ts ) {
1328 $year = substr( $ts, 0, 4 );
1329 $month = substr( $ts, 4, 2 );
1330 $day = substr( $ts, 6, 2 );
1338 ( $zy > 1582 ) ||
( ( $zy == 1582 ) && ( $zm > 10 ) ) ||
1339 ( ( $zy == 1582 ) && ( $zm == 10 ) && ( $zd > 14 ) )
1342 $zjd = (int)( ( 1461 * ( $zy +
4800 +
(int)( ( $zm - 14 ) / 12 ) ) ) / 4 ) +
1343 (int)( ( 367 * ( $zm - 2 - 12 * ( (int)( ( $zm - 14 ) / 12 ) ) ) ) / 12 ) -
1344 (int)( ( 3 * (int)( ( ( $zy +
4900 +
(int)( ( $zm - 14 ) / 12 ) ) / 100 ) ) ) / 4 ) +
1347 $zjd = 367 * $zy - (int)( ( 7 * ( $zy +
5001 +
(int)( ( $zm - 9 ) / 7 ) ) ) / 4 ) +
1348 (int)( ( 275 * $zm ) / 9 ) +
$zd +
1729777;
1351 $zl = $zjd -1948440 +
10632;
1352 $zn = (int)( ( $zl - 1 ) / 10631 );
1353 $zl = $zl - 10631 * $zn +
354;
1354 $zj = ( (int)( ( 10985 - $zl ) / 5316 ) ) * ( (int)( ( 50 * $zl ) / 17719 ) ) +
( (int)( $zl / 5670 ) ) * ( (int)( ( 43 * $zl ) / 15238 ) );
1355 $zl = $zl - ( (int)( ( 30 - $zj ) / 15 ) ) * ( (int)( ( 17719 * $zj ) / 50 ) ) - ( (int)( $zj / 16 ) ) * ( (int)( ( 15238 * $zj ) / 43 ) ) +
29;
1356 $zm = (int)( ( 24 * $zl ) / 709 );
1357 $zd = $zl - (int)( ( 709 * $zm ) / 24 );
1358 $zy = 30 * $zn +
$zj - 30;
1360 return array( $zy, $zm, $zd );
1364 * Converting Gregorian dates to Hebrew dates.
1366 * Based on a JavaScript code by Abu Mami and Yisrael Hersch
1367 * (abu-mami@kaluach.net, http://www.kaluach.net), who permitted
1368 * to translate the relevant functions into PHP and release them under
1371 * The months are counted from Tishrei = 1. In a leap year, Adar I is 13
1372 * and Adar II is 14. In a non-leap year, Adar is 6.
1378 private static function tsToHebrew( $ts ) {
1380 $year = substr( $ts, 0, 4 );
1381 $month = substr( $ts, 4, 2 );
1382 $day = substr( $ts, 6, 2 );
1384 # Calculate Hebrew year
1385 $hebrewYear = $year +
3760;
1387 # Month number when September = 1, August = 12
1389 if ( $month > 12 ) {
1396 # Calculate day of year from 1 September
1398 for ( $i = 1; $i < $month; $i++
) {
1402 # Check if the year is leap
1403 if ( $year %
400 == 0 ||
( $year %
4 == 0 && $year %
100 > 0 ) ) {
1406 } elseif ( $i == 8 ||
$i == 10 ||
$i == 1 ||
$i == 3 ) {
1413 # Calculate the start of the Hebrew year
1414 $start = self
::hebrewYearStart( $hebrewYear );
1416 # Calculate next year's start
1417 if ( $dayOfYear <= $start ) {
1418 # Day is before the start of the year - it is the previous year
1420 $nextStart = $start;
1424 # Add days since previous year's 1 September
1426 if ( ( $year %
400 == 0 ) ||
( $year %
100 != 0 && $year %
4 == 0 ) ) {
1430 # Start of the new (previous) year
1431 $start = self
::hebrewYearStart( $hebrewYear );
1434 $nextStart = self
::hebrewYearStart( $hebrewYear +
1 );
1437 # Calculate Hebrew day of year
1438 $hebrewDayOfYear = $dayOfYear - $start;
1440 # Difference between year's days
1441 $diff = $nextStart - $start;
1442 # Add 12 (or 13 for leap years) days to ignore the difference between
1443 # Hebrew and Gregorian year (353 at least vs. 365/6) - now the
1444 # difference is only about the year type
1445 if ( ( $year %
400 == 0 ) ||
( $year %
100 != 0 && $year %
4 == 0 ) ) {
1451 # Check the year pattern, and is leap year
1452 # 0 means an incomplete year, 1 means a regular year, 2 means a complete year
1453 # This is mod 30, to work on both leap years (which add 30 days of Adar I)
1454 # and non-leap years
1455 $yearPattern = $diff %
30;
1456 # Check if leap year
1457 $isLeap = $diff >= 30;
1459 # Calculate day in the month from number of day in the Hebrew year
1460 # Don't check Adar - if the day is not in Adar, we will stop before;
1461 # if it is in Adar, we will use it to check if it is Adar I or Adar II
1462 $hebrewDay = $hebrewDayOfYear;
1465 while ( $hebrewMonth <= 12 ) {
1466 # Calculate days in this month
1467 if ( $isLeap && $hebrewMonth == 6 ) {
1468 # Adar in a leap year
1470 # Leap year - has Adar I, with 30 days, and Adar II, with 29 days
1472 if ( $hebrewDay <= $days ) {
1476 # Subtract the days of Adar I
1477 $hebrewDay -= $days;
1480 if ( $hebrewDay <= $days ) {
1486 } elseif ( $hebrewMonth == 2 && $yearPattern == 2 ) {
1487 # Cheshvan in a complete year (otherwise as the rule below)
1489 } elseif ( $hebrewMonth == 3 && $yearPattern == 0 ) {
1490 # Kislev in an incomplete year (otherwise as the rule below)
1493 # Odd months have 30 days, even have 29
1494 $days = 30 - ( $hebrewMonth - 1 ) %
2;
1496 if ( $hebrewDay <= $days ) {
1497 # In the current month
1500 # Subtract the days of the current month
1501 $hebrewDay -= $days;
1502 # Try in the next month
1507 return array( $hebrewYear, $hebrewMonth, $hebrewDay, $days );
1511 * This calculates the Hebrew year start, as days since 1 September.
1512 * Based on Carl Friedrich Gauss algorithm for finding Easter date.
1513 * Used for Hebrew date.
1519 private static function hebrewYearStart( $year ) {
1520 $a = intval( ( 12 * ( $year - 1 ) +
17 ) %
19 );
1521 $b = intval( ( $year - 1 ) %
4 );
1522 $m = 32.044093161144 +
1.5542417966212 * $a +
$b / 4.0 - 0.0031777940220923 * ( $year - 1 );
1526 $Mar = intval( $m );
1532 $c = intval( ( $Mar +
3 * ( $year - 1 ) +
5 * $b +
5 ) %
7 );
1533 if ( $c == 0 && $a > 11 && $m >= 0.89772376543210 ) {
1535 } elseif ( $c == 1 && $a > 6 && $m >= 0.63287037037037 ) {
1537 } elseif ( $c == 2 ||
$c == 4 ||
$c == 6 ) {
1541 $Mar +
= intval( ( $year - 3761 ) / 100 ) - intval( ( $year - 3761 ) / 400 ) - 24;
1546 * Algorithm to convert Gregorian dates to Thai solar dates,
1547 * Minguo dates or Minguo dates.
1549 * Link: http://en.wikipedia.org/wiki/Thai_solar_calendar
1550 * http://en.wikipedia.org/wiki/Minguo_calendar
1551 * http://en.wikipedia.org/wiki/Japanese_era_name
1553 * @param $ts String: 14-character timestamp
1554 * @param $cName String: calender name
1555 * @return Array: converted year, month, day
1557 private static function tsToYear( $ts, $cName ) {
1558 $gy = substr( $ts, 0, 4 );
1559 $gm = substr( $ts, 4, 2 );
1560 $gd = substr( $ts, 6, 2 );
1562 if ( !strcmp( $cName, 'thai' ) ) {
1564 # Add 543 years to the Gregorian calendar
1565 # Months and days are identical
1566 $gy_offset = $gy +
543;
1567 } elseif ( ( !strcmp( $cName, 'minguo' ) ) ||
!strcmp( $cName, 'juche' ) ) {
1569 # Deduct 1911 years from the Gregorian calendar
1570 # Months and days are identical
1571 $gy_offset = $gy - 1911;
1572 } elseif ( !strcmp( $cName, 'tenno' ) ) {
1573 # Nengō dates up to Meiji period
1574 # Deduct years from the Gregorian calendar
1575 # depending on the nengo periods
1576 # Months and days are identical
1577 if ( ( $gy < 1912 ) ||
( ( $gy == 1912 ) && ( $gm < 7 ) ) ||
( ( $gy == 1912 ) && ( $gm == 7 ) && ( $gd < 31 ) ) ) {
1579 $gy_gannen = $gy - 1868 +
1;
1580 $gy_offset = $gy_gannen;
1581 if ( $gy_gannen == 1 ) {
1584 $gy_offset = '明治' . $gy_offset;
1586 ( ( $gy == 1912 ) && ( $gm == 7 ) && ( $gd == 31 ) ) ||
1587 ( ( $gy == 1912 ) && ( $gm >= 8 ) ) ||
1588 ( ( $gy > 1912 ) && ( $gy < 1926 ) ) ||
1589 ( ( $gy == 1926 ) && ( $gm < 12 ) ) ||
1590 ( ( $gy == 1926 ) && ( $gm == 12 ) && ( $gd < 26 ) )
1594 $gy_gannen = $gy - 1912 +
1;
1595 $gy_offset = $gy_gannen;
1596 if ( $gy_gannen == 1 ) {
1599 $gy_offset = '大正' . $gy_offset;
1601 ( ( $gy == 1926 ) && ( $gm == 12 ) && ( $gd >= 26 ) ) ||
1602 ( ( $gy > 1926 ) && ( $gy < 1989 ) ) ||
1603 ( ( $gy == 1989 ) && ( $gm == 1 ) && ( $gd < 8 ) )
1607 $gy_gannen = $gy - 1926 +
1;
1608 $gy_offset = $gy_gannen;
1609 if ( $gy_gannen == 1 ) {
1612 $gy_offset = '昭和' . $gy_offset;
1615 $gy_gannen = $gy - 1989 +
1;
1616 $gy_offset = $gy_gannen;
1617 if ( $gy_gannen == 1 ) {
1620 $gy_offset = '平成' . $gy_offset;
1626 return array( $gy_offset, $gm, $gd );
1630 * Roman number formatting up to 3000
1636 static function romanNumeral( $num ) {
1637 static $table = array(
1638 array( '', 'I', 'II', 'III', 'IV', 'V', 'VI', 'VII', 'VIII', 'IX', 'X' ),
1639 array( '', 'X', 'XX', 'XXX', 'XL', 'L', 'LX', 'LXX', 'LXXX', 'XC', 'C' ),
1640 array( '', 'C', 'CC', 'CCC', 'CD', 'D', 'DC', 'DCC', 'DCCC', 'CM', 'M' ),
1641 array( '', 'M', 'MM', 'MMM' )
1644 $num = intval( $num );
1645 if ( $num > 3000 ||
$num <= 0 ) {
1650 for ( $pow10 = 1000, $i = 3; $i >= 0; $pow10 /= 10, $i-- ) {
1651 if ( $num >= $pow10 ) {
1652 $s .= $table[$i][floor( $num / $pow10 )];
1654 $num = $num %
$pow10;
1660 * Hebrew Gematria number formatting up to 9999
1666 static function hebrewNumeral( $num ) {
1667 static $table = array(
1668 array( '', 'א', 'ב', 'ג', 'ד', 'ה', 'ו', 'ז', 'ח', 'ט', 'י' ),
1669 array( '', 'י', 'כ', 'ל', 'מ', 'נ', 'ס', 'ע', 'פ', 'צ', 'ק' ),
1670 array( '', 'ק', 'ר', 'ש', 'ת', 'תק', 'תר', 'תש', 'תת', 'תתק', 'תתר' ),
1671 array( '', 'א', 'ב', 'ג', 'ד', 'ה', 'ו', 'ז', 'ח', 'ט', 'י' )
1674 $num = intval( $num );
1675 if ( $num > 9999 ||
$num <= 0 ) {
1680 for ( $pow10 = 1000, $i = 3; $i >= 0; $pow10 /= 10, $i-- ) {
1681 if ( $num >= $pow10 ) {
1682 if ( $num == 15 ||
$num == 16 ) {
1683 $s .= $table[0][9] . $table[0][$num - 9];
1686 $s .= $table[$i][intval( ( $num / $pow10 ) )];
1687 if ( $pow10 == 1000 ) {
1692 $num = $num %
$pow10;
1694 if ( strlen( $s ) == 2 ) {
1697 $str = substr( $s, 0, strlen( $s ) - 2 ) . '"';
1698 $str .= substr( $s, strlen( $s ) - 2, 2 );
1700 $start = substr( $str, 0, strlen( $str ) - 2 );
1701 $end = substr( $str, strlen( $str ) - 2 );
1704 $str = $start . 'ך';
1707 $str = $start . 'ם';
1710 $str = $start . 'ן';
1713 $str = $start . 'ף';
1716 $str = $start . 'ץ';
1723 * This is meant to be used by time(), date(), and timeanddate() to get
1724 * the date preference they're supposed to use, it should be used in
1728 * function timeanddate([...], $format = true) {
1729 * $datePreference = $this->dateFormat($format);
1734 * @param $usePrefs Mixed: if true, the user's preference is used
1735 * if false, the site/language default is used
1736 * if int/string, assumed to be a format.
1739 function dateFormat( $usePrefs = true ) {
1742 if ( is_bool( $usePrefs ) ) {
1744 $datePreference = $wgUser->getDatePreference();
1746 $datePreference = (string)User
::getDefaultOption( 'date' );
1749 $datePreference = (string)$usePrefs;
1753 if ( $datePreference == '' ) {
1757 return $datePreference;
1761 * Get a format string for a given type and preference
1762 * @param $type string May be date, time or both
1763 * @param $pref string The format name as it appears in Messages*.php
1767 function getDateFormatString( $type, $pref ) {
1768 if ( !isset( $this->dateFormatStrings
[$type][$pref] ) ) {
1769 if ( $pref == 'default' ) {
1770 $pref = $this->getDefaultDateFormat();
1771 $df = self
::$dataCache->getSubitem( $this->mCode
, 'dateFormats', "$pref $type" );
1773 $df = self
::$dataCache->getSubitem( $this->mCode
, 'dateFormats', "$pref $type" );
1774 if ( is_null( $df ) ) {
1775 $pref = $this->getDefaultDateFormat();
1776 $df = self
::$dataCache->getSubitem( $this->mCode
, 'dateFormats', "$pref $type" );
1779 $this->dateFormatStrings
[$type][$pref] = $df;
1781 return $this->dateFormatStrings
[$type][$pref];
1785 * @param $ts Mixed: the time format which needs to be turned into a
1786 * date('YmdHis') format with wfTimestamp(TS_MW,$ts)
1787 * @param $adj Bool: whether to adjust the time output according to the
1788 * user configured offset ($timecorrection)
1789 * @param $format Mixed: true to use user's date format preference
1790 * @param $timecorrection String|bool the time offset as returned by
1791 * validateTimeZone() in Special:Preferences
1794 function date( $ts, $adj = false, $format = true, $timecorrection = false ) {
1795 $ts = wfTimestamp( TS_MW
, $ts );
1797 $ts = $this->userAdjust( $ts, $timecorrection );
1799 $df = $this->getDateFormatString( 'date', $this->dateFormat( $format ) );
1800 return $this->sprintfDate( $df, $ts );
1804 * @param $ts Mixed: the time format which needs to be turned into a
1805 * date('YmdHis') format with wfTimestamp(TS_MW,$ts)
1806 * @param $adj Bool: whether to adjust the time output according to the
1807 * user configured offset ($timecorrection)
1808 * @param $format Mixed: true to use user's date format preference
1809 * @param $timecorrection String|bool the time offset as returned by
1810 * validateTimeZone() in Special:Preferences
1813 function time( $ts, $adj = false, $format = true, $timecorrection = false ) {
1814 $ts = wfTimestamp( TS_MW
, $ts );
1816 $ts = $this->userAdjust( $ts, $timecorrection );
1818 $df = $this->getDateFormatString( 'time', $this->dateFormat( $format ) );
1819 return $this->sprintfDate( $df, $ts );
1823 * @param $ts Mixed: the time format which needs to be turned into a
1824 * date('YmdHis') format with wfTimestamp(TS_MW,$ts)
1825 * @param $adj Bool: whether to adjust the time output according to the
1826 * user configured offset ($timecorrection)
1827 * @param $format Mixed: what format to return, if it's false output the
1828 * default one (default true)
1829 * @param $timecorrection String|bool the time offset as returned by
1830 * validateTimeZone() in Special:Preferences
1833 function timeanddate( $ts, $adj = false, $format = true, $timecorrection = false ) {
1834 $ts = wfTimestamp( TS_MW
, $ts );
1836 $ts = $this->userAdjust( $ts, $timecorrection );
1838 $df = $this->getDateFormatString( 'both', $this->dateFormat( $format ) );
1839 return $this->sprintfDate( $df, $ts );
1843 * @param $key string
1844 * @return array|null
1846 function getMessage( $key ) {
1847 return self
::$dataCache->getSubitem( $this->mCode
, 'messages', $key );
1853 function getAllMessages() {
1854 return self
::$dataCache->getItem( $this->mCode
, 'messages' );
1863 function iconv( $in, $out, $string ) {
1864 # This is a wrapper for iconv in all languages except esperanto,
1865 # which does some nasty x-conversions beforehand
1867 # Even with //IGNORE iconv can whine about illegal characters in
1868 # *input* string. We just ignore those too.
1869 # REF: http://bugs.php.net/bug.php?id=37166
1870 # REF: https://bugzilla.wikimedia.org/show_bug.cgi?id=16885
1871 wfSuppressWarnings();
1872 $text = iconv( $in, $out . '//IGNORE', $string );
1873 wfRestoreWarnings();
1877 // callback functions for uc(), lc(), ucwords(), ucwordbreaks()
1880 * @param $matches array
1881 * @return mixed|string
1883 function ucwordbreaksCallbackAscii( $matches ) {
1884 return $this->ucfirst( $matches[1] );
1888 * @param $matches array
1891 function ucwordbreaksCallbackMB( $matches ) {
1892 return mb_strtoupper( $matches[0] );
1896 * @param $matches array
1899 function ucCallback( $matches ) {
1900 list( $wikiUpperChars ) = self
::getCaseMaps();
1901 return strtr( $matches[1], $wikiUpperChars );
1905 * @param $matches array
1908 function lcCallback( $matches ) {
1909 list( , $wikiLowerChars ) = self
::getCaseMaps();
1910 return strtr( $matches[1], $wikiLowerChars );
1914 * @param $matches array
1917 function ucwordsCallbackMB( $matches ) {
1918 return mb_strtoupper( $matches[0] );
1922 * @param $matches array
1925 function ucwordsCallbackWiki( $matches ) {
1926 list( $wikiUpperChars ) = self
::getCaseMaps();
1927 return strtr( $matches[0], $wikiUpperChars );
1931 * Make a string's first character uppercase
1933 * @param $str string
1937 function ucfirst( $str ) {
1939 if ( $o < 96 ) { // if already uppercase...
1941 } elseif ( $o < 128 ) {
1942 return ucfirst( $str ); // use PHP's ucfirst()
1944 // fall back to more complex logic in case of multibyte strings
1945 return $this->uc( $str, true );
1950 * Convert a string to uppercase
1952 * @param $str string
1953 * @param $first bool
1957 function uc( $str, $first = false ) {
1958 if ( function_exists( 'mb_strtoupper' ) ) {
1960 if ( $this->isMultibyte( $str ) ) {
1961 return mb_strtoupper( mb_substr( $str, 0, 1 ) ) . mb_substr( $str, 1 );
1963 return ucfirst( $str );
1966 return $this->isMultibyte( $str ) ?
mb_strtoupper( $str ) : strtoupper( $str );
1969 if ( $this->isMultibyte( $str ) ) {
1970 $x = $first ?
'^' : '';
1971 return preg_replace_callback(
1972 "/$x([a-z]|[\\xc0-\\xff][\\x80-\\xbf]*)/",
1973 array( $this, 'ucCallback' ),
1977 return $first ?
ucfirst( $str ) : strtoupper( $str );
1983 * @param $str string
1984 * @return mixed|string
1986 function lcfirst( $str ) {
1989 return strval( $str );
1990 } elseif ( $o >= 128 ) {
1991 return $this->lc( $str, true );
1992 } elseif ( $o > 96 ) {
1995 $str[0] = strtolower( $str[0] );
2001 * @param $str string
2002 * @param $first bool
2003 * @return mixed|string
2005 function lc( $str, $first = false ) {
2006 if ( function_exists( 'mb_strtolower' ) ) {
2008 if ( $this->isMultibyte( $str ) ) {
2009 return mb_strtolower( mb_substr( $str, 0, 1 ) ) . mb_substr( $str, 1 );
2011 return strtolower( substr( $str, 0, 1 ) ) . substr( $str, 1 );
2014 return $this->isMultibyte( $str ) ?
mb_strtolower( $str ) : strtolower( $str );
2017 if ( $this->isMultibyte( $str ) ) {
2018 $x = $first ?
'^' : '';
2019 return preg_replace_callback(
2020 "/$x([A-Z]|[\\xc0-\\xff][\\x80-\\xbf]*)/",
2021 array( $this, 'lcCallback' ),
2025 return $first ?
strtolower( substr( $str, 0, 1 ) ) . substr( $str, 1 ) : strtolower( $str );
2031 * @param $str string
2034 function isMultibyte( $str ) {
2035 return (bool)preg_match( '/[\x80-\xff]/', $str );
2039 * @param $str string
2040 * @return mixed|string
2042 function ucwords( $str ) {
2043 if ( $this->isMultibyte( $str ) ) {
2044 $str = $this->lc( $str );
2046 // regexp to find first letter in each word (i.e. after each space)
2047 $replaceRegexp = "/^([a-z]|[\\xc0-\\xff][\\x80-\\xbf]*)| ([a-z]|[\\xc0-\\xff][\\x80-\\xbf]*)/";
2049 // function to use to capitalize a single char
2050 if ( function_exists( 'mb_strtoupper' ) ) {
2051 return preg_replace_callback(
2053 array( $this, 'ucwordsCallbackMB' ),
2057 return preg_replace_callback(
2059 array( $this, 'ucwordsCallbackWiki' ),
2064 return ucwords( strtolower( $str ) );
2069 * capitalize words at word breaks
2071 * @param $str string
2074 function ucwordbreaks( $str ) {
2075 if ( $this->isMultibyte( $str ) ) {
2076 $str = $this->lc( $str );
2078 // since \b doesn't work for UTF-8, we explicitely define word break chars
2079 $breaks = "[ \-\(\)\}\{\.,\?!]";
2081 // find first letter after word break
2082 $replaceRegexp = "/^([a-z]|[\\xc0-\\xff][\\x80-\\xbf]*)|$breaks([a-z]|[\\xc0-\\xff][\\x80-\\xbf]*)/";
2084 if ( function_exists( 'mb_strtoupper' ) ) {
2085 return preg_replace_callback(
2087 array( $this, 'ucwordbreaksCallbackMB' ),
2091 return preg_replace_callback(
2093 array( $this, 'ucwordsCallbackWiki' ),
2098 return preg_replace_callback(
2099 '/\b([\w\x80-\xff]+)\b/',
2100 array( $this, 'ucwordbreaksCallbackAscii' ),
2107 * Return a case-folded representation of $s
2109 * This is a representation such that caseFold($s1)==caseFold($s2) if $s1
2110 * and $s2 are the same except for the case of their characters. It is not
2111 * necessary for the value returned to make sense when displayed.
2113 * Do *not* perform any other normalisation in this function. If a caller
2114 * uses this function when it should be using a more general normalisation
2115 * function, then fix the caller.
2121 function caseFold( $s ) {
2122 return $this->uc( $s );
2129 function checkTitleEncoding( $s ) {
2130 if ( is_array( $s ) ) {
2131 wfDebugDieBacktrace( 'Given array to checkTitleEncoding.' );
2133 # Check for non-UTF-8 URLs
2134 $ishigh = preg_match( '/[\x80-\xff]/', $s );
2139 $isutf8 = preg_match( '/^([\x00-\x7f]|[\xc0-\xdf][\x80-\xbf]|' .
2140 '[\xe0-\xef][\x80-\xbf]{2}|[\xf0-\xf7][\x80-\xbf]{3})+$/', $s );
2145 return $this->iconv( $this->fallback8bitEncoding(), 'utf-8', $s );
2151 function fallback8bitEncoding() {
2152 return self
::$dataCache->getItem( $this->mCode
, 'fallback8bitEncoding' );
2156 * Most writing systems use whitespace to break up words.
2157 * Some languages such as Chinese don't conventionally do this,
2158 * which requires special handling when breaking up words for
2163 function hasWordBreaks() {
2168 * Some languages such as Chinese require word segmentation,
2169 * Specify such segmentation when overridden in derived class.
2171 * @param $string String
2174 function segmentByWord( $string ) {
2179 * Some languages have special punctuation need to be normalized.
2180 * Make such changes here.
2182 * @param $string String
2185 function normalizeForSearch( $string ) {
2186 return self
::convertDoubleWidth( $string );
2190 * convert double-width roman characters to single-width.
2191 * range: ff00-ff5f ~= 0020-007f
2193 * @param $string string
2197 protected static function convertDoubleWidth( $string ) {
2198 static $full = null;
2199 static $half = null;
2201 if ( $full === null ) {
2202 $fullWidth = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
2203 $halfWidth = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
2204 $full = str_split( $fullWidth, 3 );
2205 $half = str_split( $halfWidth );
2208 $string = str_replace( $full, $half, $string );
2213 * @param $string string
2214 * @param $pattern string
2217 protected static function insertSpace( $string, $pattern ) {
2218 $string = preg_replace( $pattern, " $1 ", $string );
2219 $string = preg_replace( '/ +/', ' ', $string );
2224 * @param $termsArray array
2227 function convertForSearchResult( $termsArray ) {
2228 # some languages, e.g. Chinese, need to do a conversion
2229 # in order for search results to be displayed correctly
2234 * Get the first character of a string.
2239 function firstChar( $s ) {
2242 '/^([\x00-\x7f]|[\xc0-\xdf][\x80-\xbf]|' .
2243 '[\xe0-\xef][\x80-\xbf]{2}|[\xf0-\xf7][\x80-\xbf]{3})/',
2248 if ( isset( $matches[1] ) ) {
2249 if ( strlen( $matches[1] ) != 3 ) {
2253 // Break down Hangul syllables to grab the first jamo
2254 $code = utf8ToCodepoint( $matches[1] );
2255 if ( $code < 0xac00 ||
0xd7a4 <= $code ) {
2257 } elseif ( $code < 0xb098 ) {
2258 return "\xe3\x84\xb1";
2259 } elseif ( $code < 0xb2e4 ) {
2260 return "\xe3\x84\xb4";
2261 } elseif ( $code < 0xb77c ) {
2262 return "\xe3\x84\xb7";
2263 } elseif ( $code < 0xb9c8 ) {
2264 return "\xe3\x84\xb9";
2265 } elseif ( $code < 0xbc14 ) {
2266 return "\xe3\x85\x81";
2267 } elseif ( $code < 0xc0ac ) {
2268 return "\xe3\x85\x82";
2269 } elseif ( $code < 0xc544 ) {
2270 return "\xe3\x85\x85";
2271 } elseif ( $code < 0xc790 ) {
2272 return "\xe3\x85\x87";
2273 } elseif ( $code < 0xcc28 ) {
2274 return "\xe3\x85\x88";
2275 } elseif ( $code < 0xce74 ) {
2276 return "\xe3\x85\x8a";
2277 } elseif ( $code < 0xd0c0 ) {
2278 return "\xe3\x85\x8b";
2279 } elseif ( $code < 0xd30c ) {
2280 return "\xe3\x85\x8c";
2281 } elseif ( $code < 0xd558 ) {
2282 return "\xe3\x85\x8d";
2284 return "\xe3\x85\x8e";
2291 function initEncoding() {
2292 # Some languages may have an alternate char encoding option
2293 # (Esperanto X-coding, Japanese furigana conversion, etc)
2294 # If this language is used as the primary content language,
2295 # an override to the defaults can be set here on startup.
2302 function recodeForEdit( $s ) {
2303 # For some languages we'll want to explicitly specify
2304 # which characters make it into the edit box raw
2305 # or are converted in some way or another.
2306 global $wgEditEncoding;
2307 if ( $wgEditEncoding == '' ||
$wgEditEncoding == 'UTF-8' ) {
2310 return $this->iconv( 'UTF-8', $wgEditEncoding, $s );
2318 function recodeInput( $s ) {
2319 # Take the previous into account.
2320 global $wgEditEncoding;
2321 if ( $wgEditEncoding != '' ) {
2322 $enc = $wgEditEncoding;
2326 if ( $enc == 'UTF-8' ) {
2329 return $this->iconv( $enc, 'UTF-8', $s );
2334 * Convert a UTF-8 string to normal form C. In Malayalam and Arabic, this
2335 * also cleans up certain backwards-compatible sequences, converting them
2336 * to the modern Unicode equivalent.
2338 * This is language-specific for performance reasons only.
2344 function normalize( $s ) {
2345 global $wgAllUnicodeFixes;
2346 $s = UtfNormal
::cleanUp( $s );
2347 if ( $wgAllUnicodeFixes ) {
2348 $s = $this->transformUsingPairFile( 'normalize-ar.ser', $s );
2349 $s = $this->transformUsingPairFile( 'normalize-ml.ser', $s );
2356 * Transform a string using serialized data stored in the given file (which
2357 * must be in the serialized subdirectory of $IP). The file contains pairs
2358 * mapping source characters to destination characters.
2360 * The data is cached in process memory. This will go faster if you have the
2361 * FastStringSearch extension.
2363 * @param $file string
2364 * @param $string string
2368 function transformUsingPairFile( $file, $string ) {
2369 if ( !isset( $this->transformData
[$file] ) ) {
2370 $data = wfGetPrecompiledData( $file );
2371 if ( $data === false ) {
2372 throw new MWException( __METHOD__
. ": The transformation file $file is missing" );
2374 $this->transformData
[$file] = new ReplacementArray( $data );
2376 return $this->transformData
[$file]->replace( $string );
2380 * For right-to-left language support
2385 return self
::$dataCache->getItem( $this->mCode
, 'rtl' );
2389 * Return the correct HTML 'dir' attribute value for this language.
2393 return $this->isRTL() ?
'rtl' : 'ltr';
2397 * Return 'left' or 'right' as appropriate alignment for line-start
2398 * for this language's text direction.
2400 * Should be equivalent to CSS3 'start' text-align value....
2404 function alignStart() {
2405 return $this->isRTL() ?
'right' : 'left';
2409 * Return 'right' or 'left' as appropriate alignment for line-end
2410 * for this language's text direction.
2412 * Should be equivalent to CSS3 'end' text-align value....
2416 function alignEnd() {
2417 return $this->isRTL() ?
'left' : 'right';
2421 * A hidden direction mark (LRM or RLM), depending on the language direction
2423 * @param $opposite Boolean Get the direction mark opposite to your language
2426 function getDirMark( $opposite = false ) {
2427 $rtl = "\xE2\x80\x8F";
2428 $ltr = "\xE2\x80\x8E";
2429 if ( $opposite ) { return $this->isRTL() ?
$ltr : $rtl; }
2430 return $this->isRTL() ?
$rtl : $ltr;
2436 function capitalizeAllNouns() {
2437 return self
::$dataCache->getItem( $this->mCode
, 'capitalizeAllNouns' );
2441 * An arrow, depending on the language direction
2445 function getArrow() {
2446 return $this->isRTL() ?
'←' : '→';
2450 * To allow "foo[[bar]]" to extend the link over the whole word "foobar"
2454 function linkPrefixExtension() {
2455 return self
::$dataCache->getItem( $this->mCode
, 'linkPrefixExtension' );
2461 function getMagicWords() {
2462 return self
::$dataCache->getItem( $this->mCode
, 'magicWords' );
2465 protected function doMagicHook() {
2466 if ( $this->mMagicHookDone
) {
2469 $this->mMagicHookDone
= true;
2470 wfProfileIn( 'LanguageGetMagic' );
2471 wfRunHooks( 'LanguageGetMagic', array( &$this->mMagicExtensions
, $this->getCode() ) );
2472 wfProfileOut( 'LanguageGetMagic' );
2476 * Fill a MagicWord object with data from here
2480 function getMagic( $mw ) {
2481 $this->doMagicHook();
2483 if ( isset( $this->mMagicExtensions
[$mw->mId
] ) ) {
2484 $rawEntry = $this->mMagicExtensions
[$mw->mId
];
2486 $magicWords = $this->getMagicWords();
2487 if ( isset( $magicWords[$mw->mId
] ) ) {
2488 $rawEntry = $magicWords[$mw->mId
];
2494 if ( !is_array( $rawEntry ) ) {
2495 error_log( "\"$rawEntry\" is not a valid magic word for \"$mw->mId\"" );
2497 $mw->mCaseSensitive
= $rawEntry[0];
2498 $mw->mSynonyms
= array_slice( $rawEntry, 1 );
2503 * Add magic words to the extension array
2505 * @param $newWords array
2507 function addMagicWordsByLang( $newWords ) {
2508 $fallbackChain = $this->getFallbackLanguages();
2509 $fallbackChain = array_reverse( $fallbackChain );
2510 foreach ( $fallbackChain as $code ) {
2511 if ( isset( $newWords[$code] ) ) {
2512 $this->mMagicExtensions
= $newWords[$code] +
$this->mMagicExtensions
;
2518 * Get special page names, as an associative array
2519 * case folded alias => real name
2521 function getSpecialPageAliases() {
2522 // Cache aliases because it may be slow to load them
2523 if ( is_null( $this->mExtendedSpecialPageAliases
) ) {
2525 $this->mExtendedSpecialPageAliases
=
2526 self
::$dataCache->getItem( $this->mCode
, 'specialPageAliases' );
2527 wfRunHooks( 'LanguageGetSpecialPageAliases',
2528 array( &$this->mExtendedSpecialPageAliases
, $this->getCode() ) );
2531 return $this->mExtendedSpecialPageAliases
;
2535 * Italic is unsuitable for some languages
2537 * @param $text String: the text to be emphasized.
2540 function emphasize( $text ) {
2541 return "<em>$text</em>";
2545 * Normally we output all numbers in plain en_US style, that is
2546 * 293,291.235 for twohundredninetythreethousand-twohundredninetyone
2547 * point twohundredthirtyfive. However this is not suitable for all
2548 * languages, some such as Pakaran want ੨੯੩,੨੯੫.੨੩੫ and others such as
2549 * Icelandic just want to use commas instead of dots, and dots instead
2550 * of commas like "293.291,235".
2552 * An example of this function being called:
2554 * wfMsg( 'message', $wgLang->formatNum( $num ) )
2557 * See LanguageGu.php for the Gujarati implementation and
2558 * $separatorTransformTable on MessageIs.php for
2559 * the , => . and . => , implementation.
2561 * @todo check if it's viable to use localeconv() for the decimal
2563 * @param $number Mixed: the string to be formatted, should be an integer
2564 * or a floating point number.
2565 * @param $nocommafy Bool: set to true for special numbers like dates
2568 function formatNum( $number, $nocommafy = false ) {
2569 global $wgTranslateNumerals;
2570 if ( !$nocommafy ) {
2571 $number = $this->commafy( $number );
2572 $s = $this->separatorTransformTable();
2574 $number = strtr( $number, $s );
2578 if ( $wgTranslateNumerals ) {
2579 $s = $this->digitTransformTable();
2581 $number = strtr( $number, $s );
2589 * @param $number string
2592 function parseFormattedNumber( $number ) {
2593 $s = $this->digitTransformTable();
2595 $number = strtr( $number, array_flip( $s ) );
2598 $s = $this->separatorTransformTable();
2600 $number = strtr( $number, array_flip( $s ) );
2603 $number = strtr( $number, array( ',' => '' ) );
2608 * Adds commas to a given number
2613 function commafy( $_ ) {
2614 $digitGroupingPattern = $this->digitGroupingPattern();
2616 if ( !$digitGroupingPattern ||
$digitGroupingPattern === "###,###,###" ) {
2617 //default grouping is at thousands, use the same for ###,###,### pattern too.
2618 return strrev( (string)preg_replace( '/(\d{3})(?=\d)(?!\d*\.)/', '$1,', strrev( $_ ) ) );
2621 // Ref: http://cldr.unicode.org/translation/number-patterns
2622 $numberpart = array();
2623 $decimalpart = array();
2624 $numMatches = preg_match_all( "/(#+)/", $digitGroupingPattern, $matches );
2625 preg_match( "/\d+/", $_, $numberpart );
2626 preg_match( "/\.\d*/", $_, $decimalpart );
2627 $groupedNumber = ( count( $decimalpart ) > 0 ) ?
$decimalpart[0]:"";
2628 if ( $groupedNumber === $_){
2629 //the string does not have any number part. Eg: .12345
2630 return $groupedNumber;
2632 $start = $end = strlen( $numberpart[0] );
2633 while ( $start > 0 )
2635 $match = $matches[0][$numMatches -1] ;
2636 $matchLen = strlen( $match );
2637 $start = $end - $matchLen;
2641 $groupedNumber = substr( $_ , $start, $end -$start ) . $groupedNumber ;
2643 if ( $numMatches > 1 ) {
2644 // use the last pattern for the rest of the number
2648 $groupedNumber = "," . $groupedNumber;
2651 return $groupedNumber;
2657 function digitGroupingPattern() {
2658 return self
::$dataCache->getItem( $this->mCode
, 'digitGroupingPattern' );
2664 function digitTransformTable() {
2665 return self
::$dataCache->getItem( $this->mCode
, 'digitTransformTable' );
2671 function separatorTransformTable() {
2672 return self
::$dataCache->getItem( $this->mCode
, 'separatorTransformTable' );
2676 * Take a list of strings and build a locale-friendly comma-separated
2677 * list, using the local comma-separator message.
2678 * The last two strings are chained with an "and".
2683 function listToText( $l ) {
2685 $m = count( $l ) - 1;
2687 return $l[0] . $this->getMessageFromDB( 'and' ) . $this->getMessageFromDB( 'word-separator' ) . $l[1];
2689 for ( $i = $m; $i >= 0; $i-- ) {
2692 } elseif ( $i == $m - 1 ) {
2693 $s = $l[$i] . $this->getMessageFromDB( 'and' ) . $this->getMessageFromDB( 'word-separator' ) . $s;
2695 $s = $l[$i] . $this->getMessageFromDB( 'comma-separator' ) . $s;
2703 * Take a list of strings and build a locale-friendly comma-separated
2704 * list, using the local comma-separator message.
2705 * @param $list array of strings to put in a comma list
2708 function commaList( $list ) {
2713 array( 'parsemag', 'escapenoentities', 'language' => $this )
2719 * Take a list of strings and build a locale-friendly semicolon-separated
2720 * list, using the local semicolon-separator message.
2721 * @param $list array of strings to put in a semicolon list
2724 function semicolonList( $list ) {
2728 'semicolon-separator',
2729 array( 'parsemag', 'escapenoentities', 'language' => $this )
2735 * Same as commaList, but separate it with the pipe instead.
2736 * @param $list array of strings to put in a pipe list
2739 function pipeList( $list ) {
2744 array( 'escapenoentities', 'language' => $this )
2750 * Truncate a string to a specified length in bytes, appending an optional
2751 * string (e.g. for ellipses)
2753 * The database offers limited byte lengths for some columns in the database;
2754 * multi-byte character sets mean we need to ensure that only whole characters
2755 * are included, otherwise broken characters can be passed to the user
2757 * If $length is negative, the string will be truncated from the beginning
2759 * @param $string String to truncate
2760 * @param $length Int: maximum length (including ellipses)
2761 * @param $ellipsis String to append to the truncated text
2762 * @param $adjustLength Boolean: Subtract length of ellipsis from $length.
2763 * $adjustLength was introduced in 1.18, before that behaved as if false.
2766 function truncate( $string, $length, $ellipsis = '...', $adjustLength = true ) {
2767 # Use the localized ellipsis character
2768 if ( $ellipsis == '...' ) {
2769 $ellipsis = wfMsgExt( 'ellipsis', array( 'escapenoentities', 'language' => $this ) );
2771 # Check if there is no need to truncate
2772 if ( $length == 0 ) {
2773 return $ellipsis; // convention
2774 } elseif ( strlen( $string ) <= abs( $length ) ) {
2775 return $string; // no need to truncate
2777 $stringOriginal = $string;
2778 # If ellipsis length is >= $length then we can't apply $adjustLength
2779 if ( $adjustLength && strlen( $ellipsis ) >= abs( $length ) ) {
2780 $string = $ellipsis; // this can be slightly unexpected
2781 # Otherwise, truncate and add ellipsis...
2783 $eLength = $adjustLength ?
strlen( $ellipsis ) : 0;
2784 if ( $length > 0 ) {
2785 $length -= $eLength;
2786 $string = substr( $string, 0, $length ); // xyz...
2787 $string = $this->removeBadCharLast( $string );
2788 $string = $string . $ellipsis;
2790 $length +
= $eLength;
2791 $string = substr( $string, $length ); // ...xyz
2792 $string = $this->removeBadCharFirst( $string );
2793 $string = $ellipsis . $string;
2796 # Do not truncate if the ellipsis makes the string longer/equal (bug 22181).
2797 # This check is *not* redundant if $adjustLength, due to the single case where
2798 # LEN($ellipsis) > ABS($limit arg); $stringOriginal could be shorter than $string.
2799 if ( strlen( $string ) < strlen( $stringOriginal ) ) {
2802 return $stringOriginal;
2807 * Remove bytes that represent an incomplete Unicode character
2808 * at the end of string (e.g. bytes of the char are missing)
2810 * @param $string String
2813 protected function removeBadCharLast( $string ) {
2814 if ( $string != '' ) {
2815 $char = ord( $string[strlen( $string ) - 1] );
2817 if ( $char >= 0xc0 ) {
2818 # We got the first byte only of a multibyte char; remove it.
2819 $string = substr( $string, 0, -1 );
2820 } elseif ( $char >= 0x80 &&
2821 preg_match( '/^(.*)(?:[\xe0-\xef][\x80-\xbf]|' .
2822 '[\xf0-\xf7][\x80-\xbf]{1,2})$/', $string, $m ) )
2824 # We chopped in the middle of a character; remove it
2832 * Remove bytes that represent an incomplete Unicode character
2833 * at the start of string (e.g. bytes of the char are missing)
2835 * @param $string String
2838 protected function removeBadCharFirst( $string ) {
2839 if ( $string != '' ) {
2840 $char = ord( $string[0] );
2841 if ( $char >= 0x80 && $char < 0xc0 ) {
2842 # We chopped in the middle of a character; remove the whole thing
2843 $string = preg_replace( '/^[\x80-\xbf]+/', '', $string );
2850 * Truncate a string of valid HTML to a specified length in bytes,
2851 * appending an optional string (e.g. for ellipses), and return valid HTML
2853 * This is only intended for styled/linked text, such as HTML with
2854 * tags like <span> and <a>, were the tags are self-contained (valid HTML).
2855 * Also, this will not detect things like "display:none" CSS.
2857 * Note: since 1.18 you do not need to leave extra room in $length for ellipses.
2859 * @param string $text HTML string to truncate
2860 * @param int $length (zero/positive) Maximum length (including ellipses)
2861 * @param string $ellipsis String to append to the truncated text
2864 function truncateHtml( $text, $length, $ellipsis = '...' ) {
2865 # Use the localized ellipsis character
2866 if ( $ellipsis == '...' ) {
2867 $ellipsis = wfMsgExt( 'ellipsis', array( 'escapenoentities', 'language' => $this ) );
2869 # Check if there is clearly no need to truncate
2870 if ( $length <= 0 ) {
2871 return $ellipsis; // no text shown, nothing to format (convention)
2872 } elseif ( strlen( $text ) <= $length ) {
2873 return $text; // string short enough even *with* HTML (short-circuit)
2876 $dispLen = 0; // innerHTML legth so far
2877 $testingEllipsis = false; // checking if ellipses will make string longer/equal?
2878 $tagType = 0; // 0-open, 1-close
2879 $bracketState = 0; // 1-tag start, 2-tag name, 0-neither
2880 $entityState = 0; // 0-not entity, 1-entity
2881 $tag = $ret = ''; // accumulated tag name, accumulated result string
2882 $openTags = array(); // open tag stack
2883 $maybeState = null; // possible truncation state
2885 $textLen = strlen( $text );
2886 $neLength = max( 0, $length - strlen( $ellipsis ) ); // non-ellipsis len if truncated
2887 for ( $pos = 0; true; ++
$pos ) {
2888 # Consider truncation once the display length has reached the maximim.
2889 # We check if $dispLen > 0 to grab tags for the $neLength = 0 case.
2890 # Check that we're not in the middle of a bracket/entity...
2891 if ( $dispLen && $dispLen >= $neLength && $bracketState == 0 && !$entityState ) {
2892 if ( !$testingEllipsis ) {
2893 $testingEllipsis = true;
2894 # Save where we are; we will truncate here unless there turn out to
2895 # be so few remaining characters that truncation is not necessary.
2896 if ( !$maybeState ) { // already saved? ($neLength = 0 case)
2897 $maybeState = array( $ret, $openTags ); // save state
2899 } elseif ( $dispLen > $length && $dispLen > strlen( $ellipsis ) ) {
2900 # String in fact does need truncation, the truncation point was OK.
2901 list( $ret, $openTags ) = $maybeState; // reload state
2902 $ret = $this->removeBadCharLast( $ret ); // multi-byte char fix
2903 $ret .= $ellipsis; // add ellipsis
2907 if ( $pos >= $textLen ) break; // extra iteration just for above checks
2909 # Read the next char...
2911 $lastCh = $pos ?
$text[$pos - 1] : '';
2912 $ret .= $ch; // add to result string
2914 $this->truncate_endBracket( $tag, $tagType, $lastCh, $openTags ); // for bad HTML
2915 $entityState = 0; // for bad HTML
2916 $bracketState = 1; // tag started (checking for backslash)
2917 } elseif ( $ch == '>' ) {
2918 $this->truncate_endBracket( $tag, $tagType, $lastCh, $openTags );
2919 $entityState = 0; // for bad HTML
2920 $bracketState = 0; // out of brackets
2921 } elseif ( $bracketState == 1 ) {
2923 $tagType = 1; // close tag (e.g. "</span>")
2925 $tagType = 0; // open tag (e.g. "<span>")
2928 $bracketState = 2; // building tag name
2929 } elseif ( $bracketState == 2 ) {
2933 // Name found (e.g. "<a href=..."), add on tag attributes...
2934 $pos +
= $this->truncate_skip( $ret, $text, "<>", $pos +
1 );
2936 } elseif ( $bracketState == 0 ) {
2937 if ( $entityState ) {
2940 $dispLen++
; // entity is one displayed char
2943 if ( $neLength == 0 && !$maybeState ) {
2944 // Save state without $ch. We want to *hit* the first
2945 // display char (to get tags) but not *use* it if truncating.
2946 $maybeState = array( substr( $ret, 0, -1 ), $openTags );
2949 $entityState = 1; // entity found, (e.g. " ")
2951 $dispLen++
; // this char is displayed
2952 // Add the next $max display text chars after this in one swoop...
2953 $max = ( $testingEllipsis ?
$length : $neLength ) - $dispLen;
2954 $skipped = $this->truncate_skip( $ret, $text, "<>&", $pos +
1, $max );
2955 $dispLen +
= $skipped;
2961 // Close the last tag if left unclosed by bad HTML
2962 $this->truncate_endBracket( $tag, $text[$textLen - 1], $tagType, $openTags );
2963 while ( count( $openTags ) > 0 ) {
2964 $ret .= '</' . array_pop( $openTags ) . '>'; // close open tags
2970 * truncateHtml() helper function
2971 * like strcspn() but adds the skipped chars to $ret
2980 private function truncate_skip( &$ret, $text, $search, $start, $len = null ) {
2981 if ( $len === null ) {
2982 $len = -1; // -1 means "no limit" for strcspn
2983 } elseif ( $len < 0 ) {
2987 if ( $start < strlen( $text ) ) {
2988 $skipCount = strcspn( $text, $search, $start, $len );
2989 $ret .= substr( $text, $start, $skipCount );
2995 * truncateHtml() helper function
2996 * (a) push or pop $tag from $openTags as needed
2997 * (b) clear $tag value
2998 * @param String &$tag Current HTML tag name we are looking at
2999 * @param int $tagType (0-open tag, 1-close tag)
3000 * @param char $lastCh Character before the '>' that ended this tag
3001 * @param array &$openTags Open tag stack (not accounting for $tag)
3003 private function truncate_endBracket( &$tag, $tagType, $lastCh, &$openTags ) {
3004 $tag = ltrim( $tag );
3006 if ( $tagType == 0 && $lastCh != '/' ) {
3007 $openTags[] = $tag; // tag opened (didn't close itself)
3008 } elseif ( $tagType == 1 ) {
3009 if ( $openTags && $tag == $openTags[count( $openTags ) - 1] ) {
3010 array_pop( $openTags ); // tag closed
3018 * Grammatical transformations, needed for inflected languages
3019 * Invoked by putting {{grammar:case|word}} in a message
3021 * @param $word string
3022 * @param $case string
3025 function convertGrammar( $word, $case ) {
3026 global $wgGrammarForms;
3027 if ( isset( $wgGrammarForms[$this->getCode()][$case][$word] ) ) {
3028 return $wgGrammarForms[$this->getCode()][$case][$word];
3034 * Provides an alternative text depending on specified gender.
3035 * Usage {{gender:username|masculine|feminine|neutral}}.
3036 * username is optional, in which case the gender of current user is used,
3037 * but only in (some) interface messages; otherwise default gender is used.
3038 * If second or third parameter are not specified, masculine is used.
3039 * These details may be overriden per language.
3041 * @param $gender string
3042 * @param $forms array
3046 function gender( $gender, $forms ) {
3047 if ( !count( $forms ) ) {
3050 $forms = $this->preConvertPlural( $forms, 2 );
3051 if ( $gender === 'male' ) {
3054 if ( $gender === 'female' ) {
3057 return isset( $forms[2] ) ?
$forms[2] : $forms[0];
3061 * Plural form transformations, needed for some languages.
3062 * For example, there are 3 form of plural in Russian and Polish,
3063 * depending on "count mod 10". See [[w:Plural]]
3064 * For English it is pretty simple.
3066 * Invoked by putting {{plural:count|wordform1|wordform2}}
3067 * or {{plural:count|wordform1|wordform2|wordform3}}
3069 * Example: {{plural:{{NUMBEROFARTICLES}}|article|articles}}
3071 * @param $count Integer: non-localized number
3072 * @param $forms Array: different plural forms
3073 * @return string Correct form of plural for $count in this language
3075 function convertPlural( $count, $forms ) {
3076 if ( !count( $forms ) ) {
3079 $forms = $this->preConvertPlural( $forms, 2 );
3081 return ( $count == 1 ) ?
$forms[0] : $forms[1];
3085 * Checks that convertPlural was given an array and pads it to requested
3086 * amount of forms by copying the last one.
3088 * @param $count Integer: How many forms should there be at least
3089 * @param $forms Array of forms given to convertPlural
3090 * @return array Padded array of forms or an exception if not an array
3092 protected function preConvertPlural( /* Array */ $forms, $count ) {
3093 while ( count( $forms ) < $count ) {
3094 $forms[] = $forms[count( $forms ) - 1];
3100 * This translates the duration ("1 week", "4 days", etc)
3101 * as well as the expiry time (which is an absolute timestamp).
3102 * @param $str String: the validated block duration in English
3103 * @return Somehow translated block duration
3104 * @see LanguageFi.php for example implementation
3106 function translateBlockExpiry( $str ) {
3107 $duration = SpecialBlock
::getSuggestedDurations( $this );
3108 foreach ( $duration as $show => $value ) {
3109 if ( strcmp( $str, $value ) == 0 ) {
3110 return htmlspecialchars( trim( $show ) );
3114 // Since usually only infinite or indefinite is only on list, so try
3115 // equivalents if still here.
3116 $indefs = array( 'infinite', 'infinity', 'indefinite' );
3117 if ( in_array( $str, $indefs ) ) {
3118 foreach ( $indefs as $val ) {
3119 $show = array_search( $val, $duration, true );
3120 if ( $show !== false ) {
3121 return htmlspecialchars( trim( $show ) );
3125 // If no duration is given, but a timestamp, display that
3126 return ( strtotime( $str ) ?
$this->timeanddate( strtotime( $str ) ) : $str );
3130 * languages like Chinese need to be segmented in order for the diff
3133 * @param $text String
3136 function segmentForDiff( $text ) {
3141 * and unsegment to show the result
3143 * @param $text String
3146 function unsegmentForDiff( $text ) {
3151 * convert text to all supported variants
3153 * @param $text string
3156 function autoConvertToAllVariants( $text ) {
3157 return $this->mConverter
->autoConvertToAllVariants( $text );
3161 * convert text to different variants of a language.
3163 * @param $text string
3166 function convert( $text ) {
3167 return $this->mConverter
->convert( $text );
3172 * Convert a Title object to a string in the preferred variant
3174 * @param $title Title
3177 function convertTitle( $title ) {
3178 return $this->mConverter
->convertTitle( $title );
3182 * Check if this is a language with variants
3186 function hasVariants() {
3187 return sizeof( $this->getVariants() ) > 1;
3191 * Put custom tags (e.g. -{ }-) around math to prevent conversion
3193 * @param $text string
3196 function armourMath( $text ) {
3197 return $this->mConverter
->armourMath( $text );
3201 * Perform output conversion on a string, and encode for safe HTML output.
3202 * @param $text String text to be converted
3203 * @param $isTitle Bool whether this conversion is for the article title
3205 * @todo this should get integrated somewhere sane
3207 function convertHtml( $text, $isTitle = false ) {
3208 return htmlspecialchars( $this->convert( $text, $isTitle ) );
3212 * @param $key string
3215 function convertCategoryKey( $key ) {
3216 return $this->mConverter
->convertCategoryKey( $key );
3220 * Get the list of variants supported by this language
3221 * see sample implementation in LanguageZh.php
3223 * @return array an array of language codes
3225 function getVariants() {
3226 return $this->mConverter
->getVariants();
3232 function getPreferredVariant() {
3233 return $this->mConverter
->getPreferredVariant();
3239 function getDefaultVariant() {
3240 return $this->mConverter
->getDefaultVariant();
3246 function getURLVariant() {
3247 return $this->mConverter
->getURLVariant();
3251 * If a language supports multiple variants, it is
3252 * possible that non-existing link in one variant
3253 * actually exists in another variant. this function
3254 * tries to find it. See e.g. LanguageZh.php
3256 * @param $link String: the name of the link
3257 * @param $nt Mixed: the title object of the link
3258 * @param $ignoreOtherCond Boolean: to disable other conditions when
3259 * we need to transclude a template or update a category's link
3260 * @return null the input parameters may be modified upon return
3262 function findVariantLink( &$link, &$nt, $ignoreOtherCond = false ) {
3263 $this->mConverter
->findVariantLink( $link, $nt, $ignoreOtherCond );
3267 * If a language supports multiple variants, converts text
3268 * into an array of all possible variants of the text:
3269 * 'variant' => text in that variant
3271 * @deprecated since 1.17 Use autoConvertToAllVariants()
3273 * @param $text string
3277 function convertLinkToAllVariants( $text ) {
3278 return $this->mConverter
->convertLinkToAllVariants( $text );
3282 * returns language specific options used by User::getPageRenderHash()
3283 * for example, the preferred language variant
3287 function getExtraHashOptions() {
3288 return $this->mConverter
->getExtraHashOptions();
3292 * For languages that support multiple variants, the title of an
3293 * article may be displayed differently in different variants. this
3294 * function returns the apporiate title defined in the body of the article.
3298 function getParsedTitle() {
3299 return $this->mConverter
->getParsedTitle();
3303 * Enclose a string with the "no conversion" tag. This is used by
3304 * various functions in the Parser
3306 * @param $text String: text to be tagged for no conversion
3307 * @param $noParse bool
3308 * @return string the tagged text
3310 function markNoConversion( $text, $noParse = false ) {
3311 return $this->mConverter
->markNoConversion( $text, $noParse );
3315 * A regular expression to match legal word-trailing characters
3316 * which should be merged onto a link of the form [[foo]]bar.
3320 function linkTrail() {
3321 return self
::$dataCache->getItem( $this->mCode
, 'linkTrail' );
3327 function getLangObj() {
3332 * Get the RFC 3066 code for this language object
3336 function getCode() {
3337 return $this->mCode
;
3341 * @param $code string
3343 function setCode( $code ) {
3344 $this->mCode
= $code;
3348 * Get the name of a file for a certain language code
3349 * @param $prefix string Prepend this to the filename
3350 * @param $code string Language code
3351 * @param $suffix string Append this to the filename
3352 * @return string $prefix . $mangledCode . $suffix
3354 static function getFileName( $prefix = 'Language', $code, $suffix = '.php' ) {
3355 // Protect against path traversal
3356 if ( !Language
::isValidCode( $code )
3357 ||
strcspn( $code, ":/\\\000" ) !== strlen( $code ) )
3359 throw new MWException( "Invalid language code \"$code\"" );
3362 return $prefix . str_replace( '-', '_', ucfirst( $code ) ) . $suffix;
3366 * Get the language code from a file name. Inverse of getFileName()
3367 * @param $filename string $prefix . $languageCode . $suffix
3368 * @param $prefix string Prefix before the language code
3369 * @param $suffix string Suffix after the language code
3370 * @return string Language code, or false if $prefix or $suffix isn't found
3372 static function getCodeFromFileName( $filename, $prefix = 'Language', $suffix = '.php' ) {
3374 preg_match( '/' . preg_quote( $prefix, '/' ) . '([A-Z][a-z_]+)' .
3375 preg_quote( $suffix, '/' ) . '/', $filename, $m );
3376 if ( !count( $m ) ) {
3379 return str_replace( '_', '-', strtolower( $m[1] ) );
3383 * @param $code string
3386 static function getMessagesFileName( $code ) {
3388 return self
::getFileName( "$IP/languages/messages/Messages", $code, '.php' );
3392 * @param $code string
3395 static function getClassFileName( $code ) {
3397 return self
::getFileName( "$IP/languages/classes/Language", $code, '.php' );
3401 * Get the first fallback for a given language.
3403 * @param $code string
3405 * @return false|string
3407 static function getFallbackFor( $code ) {
3408 if ( $code === 'en' ||
!Language
::isValidBuiltInCode( $code ) ) {
3411 $fallbacks = self
::getFallbacksFor( $code );
3412 $first = array_shift( $fallbacks );
3418 * Get the ordered list of fallback languages.
3421 * @param $code string Language code
3424 static function getFallbacksFor( $code ) {
3425 if ( $code === 'en' ||
!Language
::isValidBuiltInCode( $code ) ) {
3428 $v = self
::getLocalisationCache()->getItem( $code, 'fallback' );
3429 $v = array_map( 'trim', explode( ',', $v ) );
3430 if ( $v[count( $v ) - 1] !== 'en' ) {
3438 * Get all messages for a given language
3439 * WARNING: this may take a long time. If you just need all message *keys*
3440 * but need the *contents* of only a few messages, consider using getMessageKeysFor().
3442 * @param $code string
3446 static function getMessagesFor( $code ) {
3447 return self
::getLocalisationCache()->getItem( $code, 'messages' );
3451 * Get a message for a given language
3453 * @param $key string
3454 * @param $code string
3458 static function getMessageFor( $key, $code ) {
3459 return self
::getLocalisationCache()->getSubitem( $code, 'messages', $key );
3463 * Get all message keys for a given language. This is a faster alternative to
3464 * array_keys( Language::getMessagesFor( $code ) )
3467 * @param $code string Language code
3468 * @return array of message keys (strings)
3470 static function getMessageKeysFor( $code ) {
3471 return self
::getLocalisationCache()->getSubItemList( $code, 'messages' );
3478 function fixVariableInNamespace( $talk ) {
3479 if ( strpos( $talk, '$1' ) === false ) {
3483 global $wgMetaNamespace;
3484 $talk = str_replace( '$1', $wgMetaNamespace, $talk );
3486 # Allow grammar transformations
3487 # Allowing full message-style parsing would make simple requests
3488 # such as action=raw much more expensive than they need to be.
3489 # This will hopefully cover most cases.
3490 $talk = preg_replace_callback( '/{{grammar:(.*?)\|(.*?)}}/i',
3491 array( &$this, 'replaceGrammarInNamespace' ), $talk );
3492 return str_replace( ' ', '_', $talk );
3499 function replaceGrammarInNamespace( $m ) {
3500 return $this->convertGrammar( trim( $m[2] ), trim( $m[1] ) );
3504 * @throws MWException
3507 static function getCaseMaps() {
3508 static $wikiUpperChars, $wikiLowerChars;
3509 if ( isset( $wikiUpperChars ) ) {
3510 return array( $wikiUpperChars, $wikiLowerChars );
3513 wfProfileIn( __METHOD__
);
3514 $arr = wfGetPrecompiledData( 'Utf8Case.ser' );
3515 if ( $arr === false ) {
3516 throw new MWException(
3517 "Utf8Case.ser is missing, please run \"make\" in the serialized directory\n" );
3519 $wikiUpperChars = $arr['wikiUpperChars'];
3520 $wikiLowerChars = $arr['wikiLowerChars'];
3521 wfProfileOut( __METHOD__
);
3522 return array( $wikiUpperChars, $wikiLowerChars );
3526 * Decode an expiry (block, protection, etc) which has come from the DB
3528 * @param $expiry String: Database expiry String
3529 * @param $format Bool|Int true to process using language functions, or TS_ constant
3530 * to return the expiry in a given timestamp
3533 public function formatExpiry( $expiry, $format = true ) {
3534 static $infinity, $infinityMsg;
3535 if ( $infinity === null ) {
3536 $infinityMsg = wfMessage( 'infiniteblock' );
3537 $infinity = wfGetDB( DB_SLAVE
)->getInfinity();
3540 if ( $expiry == '' ||
$expiry == $infinity ) {
3541 return $format === true
3545 return $format === true
3546 ?
$this->timeanddate( $expiry )
3547 : wfTimestamp( $format, $expiry );
3553 * @param $seconds int|float
3554 * @param $format String Optional, one of ("avoidseconds","avoidminutes"):
3555 * "avoidseconds" - don't mention seconds if $seconds >= 1 hour
3556 * "avoidminutes" - don't mention seconds/minutes if $seconds > 48 hours
3559 function formatTimePeriod( $seconds, $format = false ) {
3560 if ( round( $seconds * 10 ) < 100 ) {
3561 $s = $this->formatNum( sprintf( "%.1f", round( $seconds * 10 ) / 10 ) );
3562 $s .= $this->getMessageFromDB( 'seconds-abbrev' );
3563 } elseif ( round( $seconds ) < 60 ) {
3564 $s = $this->formatNum( round( $seconds ) );
3565 $s .= $this->getMessageFromDB( 'seconds-abbrev' );
3566 } elseif ( round( $seconds ) < 3600 ) {
3567 $minutes = floor( $seconds / 60 );
3568 $secondsPart = round( fmod( $seconds, 60 ) );
3569 if ( $secondsPart == 60 ) {
3573 $s = $this->formatNum( $minutes ) . $this->getMessageFromDB( 'minutes-abbrev' );
3575 $s .= $this->formatNum( $secondsPart ) . $this->getMessageFromDB( 'seconds-abbrev' );
3576 } elseif ( round( $seconds ) <= 2 * 86400 ) {
3577 $hours = floor( $seconds / 3600 );
3578 $minutes = floor( ( $seconds - $hours * 3600 ) / 60 );
3579 $secondsPart = round( $seconds - $hours * 3600 - $minutes * 60 );
3580 if ( $secondsPart == 60 ) {
3584 if ( $minutes == 60 ) {
3588 $s = $this->formatNum( $hours ) . $this->getMessageFromDB( 'hours-abbrev' );
3590 $s .= $this->formatNum( $minutes ) . $this->getMessageFromDB( 'minutes-abbrev' );
3591 if ( !in_array( $format, array( 'avoidseconds', 'avoidminutes' ) ) ) {
3592 $s .= ' ' . $this->formatNum( $secondsPart ) .
3593 $this->getMessageFromDB( 'seconds-abbrev' );
3596 $days = floor( $seconds / 86400 );
3597 if ( $format === 'avoidminutes' ) {
3598 $hours = round( ( $seconds - $days * 86400 ) / 3600 );
3599 if ( $hours == 24 ) {
3603 $s = $this->formatNum( $days ) . $this->getMessageFromDB( 'days-abbrev' );
3605 $s .= $this->formatNum( $hours ) . $this->getMessageFromDB( 'hours-abbrev' );
3606 } elseif ( $format === 'avoidseconds' ) {
3607 $hours = floor( ( $seconds - $days * 86400 ) / 3600 );
3608 $minutes = round( ( $seconds - $days * 86400 - $hours * 3600 ) / 60 );
3609 if ( $minutes == 60 ) {
3613 if ( $hours == 24 ) {
3617 $s = $this->formatNum( $days ) . $this->getMessageFromDB( 'days-abbrev' );
3619 $s .= $this->formatNum( $hours ) . $this->getMessageFromDB( 'hours-abbrev' );
3621 $s .= $this->formatNum( $minutes ) . $this->getMessageFromDB( 'minutes-abbrev' );
3623 $s = $this->formatNum( $days ) . $this->getMessageFromDB( 'days-abbrev' );
3625 $s .= $this->formatTimePeriod( $seconds - $days * 86400, $format );
3635 function formatBitrate( $bps ) {
3636 $units = array( 'bps', 'kbps', 'Mbps', 'Gbps' );
3638 return $this->formatNum( $bps ) . $units[0];
3640 $unitIndex = floor( log10( $bps ) / 3 );
3641 $mantissa = $bps / pow( 1000, $unitIndex );
3642 if ( $mantissa < 10 ) {
3643 $mantissa = round( $mantissa, 1 );
3645 $mantissa = round( $mantissa );
3647 return $this->formatNum( $mantissa ) . $units[$unitIndex];
3651 * Format a size in bytes for output, using an appropriate
3652 * unit (B, KB, MB or GB) according to the magnitude in question
3654 * @param $size int Size to format
3655 * @return string Plain text (not HTML)
3657 function formatSize( $size ) {
3658 // For small sizes no decimal places necessary
3660 if ( $size > 1024 ) {
3661 $size = $size / 1024;
3662 if ( $size > 1024 ) {
3663 $size = $size / 1024;
3664 // For MB and bigger two decimal places are smarter
3666 if ( $size > 1024 ) {
3667 $size = $size / 1024;
3668 $msg = 'size-gigabytes';
3670 $msg = 'size-megabytes';
3673 $msg = 'size-kilobytes';
3676 $msg = 'size-bytes';
3678 $size = round( $size, $round );
3679 $text = $this->getMessageFromDB( $msg );
3680 return str_replace( '$1', $this->formatNum( $size ), $text );
3684 * Get the conversion rule title, if any.
3688 function getConvRuleTitle() {
3689 return $this->mConverter
->getConvRuleTitle();