dépôts / lhc / web / wiklou.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
history | raw | HEAD
(bug 36819) Make language names lowercase first letter where usual
[lhc/web/wiklou.git] / languages / Language.php
1 <?php
2 /**
3 * Internationalisation code
4 *
5 * @file
6 * @ingroup Language
7 */
8
9 /**
10 * @defgroup Language Language
11 */
12
13 if ( !defined( 'MEDIAWIKI' ) ) {
14 echo "This file is part of MediaWiki, it is not a valid entry point.\n";
15 exit( 1 );
16 }
17
18 # Read language names
19 global $wgLanguageNames;
20 require_once( dirname( __FILE__ ) . '/Names.php' );
21
22 if ( function_exists( 'mb_strtoupper' ) ) {
23 mb_internal_encoding( 'UTF-8' );
24 }
25
26 /**
27 * a fake language converter
28 *
29 * @ingroup Language
30 */
31 class FakeConverter {
32
33 /**
34 * @var Language
35 */
36 var $mLang;
37 function __construct( $langobj ) { $this->mLang = $langobj; }
38 function autoConvertToAllVariants( $text ) { return array( $this->mLang->getCode() => $text ); }
39 function convert( $t ) { return $t; }
40 function convertTo( $text, $variant ) { return $text; }
41 function convertTitle( $t ) { return $t->getPrefixedText(); }
42 function getVariants() { return array( $this->mLang->getCode() ); }
43 function getPreferredVariant() { return $this->mLang->getCode(); }
44 function getDefaultVariant() { return $this->mLang->getCode(); }
45 function getURLVariant() { return ''; }
46 function getConvRuleTitle() { return false; }
47 function findVariantLink( &$l, &$n, $ignoreOtherCond = false ) { }
48 function getExtraHashOptions() { return ''; }
49 function getParsedTitle() { return ''; }
50 function markNoConversion( $text, $noParse = false ) { return $text; }
51 function convertCategoryKey( $key ) { return $key; }
52 function convertLinkToAllVariants( $text ) { return $this->autoConvertToAllVariants( $text ); }
53 function armourMath( $text ) { return $text; }
54 }
55
56 /**
57 * Internationalisation code
58 * @ingroup Language
59 */
60 class Language {
61
62 /**
63 * @var LanguageConverter
64 */
65 var $mConverter;
66
67 var $mVariants, $mCode, $mLoaded = false;
68 var $mMagicExtensions = array(), $mMagicHookDone = false;
69 private $mHtmlCode = null;
70
71 var $dateFormatStrings = array();
72 var $mExtendedSpecialPageAliases;
73
74 protected $namespaceNames, $mNamespaceIds, $namespaceAliases;
75
76 /**
77 * ReplacementArray object caches
78 */
79 var $transformData = array();
80
81 /**
82 * @var LocalisationCache
83 */
84 static public $dataCache;
85
86 static public $mLangObjCache = array();
87
88 static public $mWeekdayMsgs = array(
89 'sunday', 'monday', 'tuesday', 'wednesday', 'thursday',
90 'friday', 'saturday'
91 );
92
93 static public $mWeekdayAbbrevMsgs = array(
94 'sun', 'mon', 'tue', 'wed', 'thu', 'fri', 'sat'
95 );
96
97 static public $mMonthMsgs = array(
98 'january', 'february', 'march', 'april', 'may_long', 'june',
99 'july', 'august', 'september', 'october', 'november',
100 'december'
101 );
102 static public $mMonthGenMsgs = array(
103 'january-gen', 'february-gen', 'march-gen', 'april-gen', 'may-gen', 'june-gen',
104 'july-gen', 'august-gen', 'september-gen', 'october-gen', 'november-gen',
105 'december-gen'
106 );
107 static public $mMonthAbbrevMsgs = array(
108 'jan', 'feb', 'mar', 'apr', 'may', 'jun', 'jul', 'aug',
109 'sep', 'oct', 'nov', 'dec'
110 );
111
112 static public $mIranianCalendarMonthMsgs = array(
113 'iranian-calendar-m1', 'iranian-calendar-m2', 'iranian-calendar-m3',
114 'iranian-calendar-m4', 'iranian-calendar-m5', 'iranian-calendar-m6',
115 'iranian-calendar-m7', 'iranian-calendar-m8', 'iranian-calendar-m9',
116 'iranian-calendar-m10', 'iranian-calendar-m11', 'iranian-calendar-m12'
117 );
118
119 static public $mHebrewCalendarMonthMsgs = array(
120 'hebrew-calendar-m1', 'hebrew-calendar-m2', 'hebrew-calendar-m3',
121 'hebrew-calendar-m4', 'hebrew-calendar-m5', 'hebrew-calendar-m6',
122 'hebrew-calendar-m7', 'hebrew-calendar-m8', 'hebrew-calendar-m9',
123 'hebrew-calendar-m10', 'hebrew-calendar-m11', 'hebrew-calendar-m12',
124 'hebrew-calendar-m6a', 'hebrew-calendar-m6b'
125 );
126
127 static public $mHebrewCalendarMonthGenMsgs = array(
128 'hebrew-calendar-m1-gen', 'hebrew-calendar-m2-gen', 'hebrew-calendar-m3-gen',
129 'hebrew-calendar-m4-gen', 'hebrew-calendar-m5-gen', 'hebrew-calendar-m6-gen',
130 'hebrew-calendar-m7-gen', 'hebrew-calendar-m8-gen', 'hebrew-calendar-m9-gen',
131 'hebrew-calendar-m10-gen', 'hebrew-calendar-m11-gen', 'hebrew-calendar-m12-gen',
132 'hebrew-calendar-m6a-gen', 'hebrew-calendar-m6b-gen'
133 );
134
135 static public $mHijriCalendarMonthMsgs = array(
136 'hijri-calendar-m1', 'hijri-calendar-m2', 'hijri-calendar-m3',
137 'hijri-calendar-m4', 'hijri-calendar-m5', 'hijri-calendar-m6',
138 'hijri-calendar-m7', 'hijri-calendar-m8', 'hijri-calendar-m9',
139 'hijri-calendar-m10', 'hijri-calendar-m11', 'hijri-calendar-m12'
140 );
141
142 /**
143 * @since 1.20
144 * @var array
145 */
146 static public $durationIntervals = array(
147 'millennia' => 31557600000,
148 'centuries' => 3155760000,
149 'decades' => 315576000,
150 'years' => 31557600, // 86400 * 365.25
151 'weeks' => 604800,
152 'days' => 86400,
153 'hours' => 3600,
154 'minutes' => 60,
155 'seconds' => 1,
156 );
157
158 /**
159 * Get a cached language object for a given language code
160 * @param $code String
161 * @return Language
162 */
163 static function factory( $code ) {
164 if ( !isset( self::$mLangObjCache[$code] ) ) {
165 if ( count( self::$mLangObjCache ) > 10 ) {
166 // Don't keep a billion objects around, that's stupid.
167 self::$mLangObjCache = array();
168 }
169 self::$mLangObjCache[$code] = self::newFromCode( $code );
170 }
171 return self::$mLangObjCache[$code];
172 }
173
174 /**
175 * Create a language object for a given language code
176 * @param $code String
177 * @throws MWException
178 * @return Language
179 */
180 protected static function newFromCode( $code ) {
181 // Protect against path traversal below
182 if ( !Language::isValidCode( $code )
183 || strcspn( $code, ":/\\\000" ) !== strlen( $code ) )
184 {
185 throw new MWException( "Invalid language code \"$code\"" );
186 }
187
188 if ( !Language::isValidBuiltInCode( $code ) ) {
189 // It's not possible to customise this code with class files, so
190 // just return a Language object. This is to support uselang= hacks.
191 $lang = new Language;
192 $lang->setCode( $code );
193 return $lang;
194 }
195
196 // Check if there is a language class for the code
197 $class = self::classFromCode( $code );
198 self::preloadLanguageClass( $class );
199 if ( MWInit::classExists( $class ) ) {
200 $lang = new $class;
201 return $lang;
202 }
203
204 // Keep trying the fallback list until we find an existing class
205 $fallbacks = Language::getFallbacksFor( $code );
206 foreach ( $fallbacks as $fallbackCode ) {
207 if ( !Language::isValidBuiltInCode( $fallbackCode ) ) {
208 throw new MWException( "Invalid fallback '$fallbackCode' in fallback sequence for '$code'" );
209 }
210
211 $class = self::classFromCode( $fallbackCode );
212 self::preloadLanguageClass( $class );
213 if ( MWInit::classExists( $class ) ) {
214 $lang = Language::newFromCode( $fallbackCode );
215 $lang->setCode( $code );
216 return $lang;
217 }
218 }
219
220 throw new MWException( "Invalid fallback sequence for language '$code'" );
221 }
222
223 /**
224 * Returns true if a language code string is of a valid form, whether or
225 * not it exists. This includes codes which are used solely for
226 * customisation via the MediaWiki namespace.
227 *
228 * @param $code string
229 *
230 * @return bool
231 */
232 public static function isValidCode( $code ) {
233 return
234 strcspn( $code, ":/\\\000" ) === strlen( $code )
235 && !preg_match( Title::getTitleInvalidRegex(), $code );
236 }
237
238 /**
239 * Returns true if a language code is of a valid form for the purposes of
240 * internal customisation of MediaWiki, via Messages*.php.
241 *
242 * @param $code string
243 *
244 * @since 1.18
245 * @return bool
246 */
247 public static function isValidBuiltInCode( $code ) {
248
249 if( !is_string($code) ) {
250 $type = gettype( $code );
251 if( $type === 'object' ) {
252 $addmsg = " of class " . get_class( $code );
253 } else {
254 $addmsg = '';
255 }
256 throw new MWException( __METHOD__ . " must be passed a string, $type given$addmsg" );
257 }
258
259 return preg_match( '/^[a-z0-9-]+$/i', $code );
260 }
261
262 /**
263 * @param $code
264 * @return String Name of the language class
265 */
266 public static function classFromCode( $code ) {
267 if ( $code == 'en' ) {
268 return 'Language';
269 } else {
270 return 'Language' . str_replace( '-', '_', ucfirst( $code ) );
271 }
272 }
273
274 /**
275 * Includes language class files
276 *
277 * @param $class string Name of the language class
278 */
279 public static function preloadLanguageClass( $class ) {
280 global $IP;
281
282 if ( $class === 'Language' ) {
283 return;
284 }
285
286 if ( !defined( 'MW_COMPILED' ) ) {
287 // Preload base classes to work around APC/PHP5 bug
288 if ( file_exists( "$IP/languages/classes/$class.deps.php" ) ) {
289 include_once( "$IP/languages/classes/$class.deps.php" );
290 }
291 if ( file_exists( "$IP/languages/classes/$class.php" ) ) {
292 include_once( "$IP/languages/classes/$class.php" );
293 }
294 }
295 }
296
297 /**
298 * Get the LocalisationCache instance
299 *
300 * @return LocalisationCache
301 */
302 public static function getLocalisationCache() {
303 if ( is_null( self::$dataCache ) ) {
304 global $wgLocalisationCacheConf;
305 $class = $wgLocalisationCacheConf['class'];
306 self::$dataCache = new $class( $wgLocalisationCacheConf );
307 }
308 return self::$dataCache;
309 }
310
311 function __construct() {
312 $this->mConverter = new FakeConverter( $this );
313 // Set the code to the name of the descendant
314 if ( get_class( $this ) == 'Language' ) {
315 $this->mCode = 'en';
316 } else {
317 $this->mCode = str_replace( '_', '-', strtolower( substr( get_class( $this ), 8 ) ) );
318 }
319 self::getLocalisationCache();
320 }
321
322 /**
323 * Reduce memory usage
324 */
325 function __destruct() {
326 foreach ( $this as $name => $value ) {
327 unset( $this->$name );
328 }
329 }
330
331 /**
332 * Hook which will be called if this is the content language.
333 * Descendants can use this to register hook functions or modify globals
334 */
335 function initContLang() { }
336
337 /**
338 * Same as getFallbacksFor for current language.
339 * @return array|bool
340 * @deprecated in 1.19
341 */
342 function getFallbackLanguageCode() {
343 wfDeprecated( __METHOD__ );
344 return self::getFallbackFor( $this->mCode );
345 }
346
347 /**
348 * @return array
349 * @since 1.19
350 */
351 function getFallbackLanguages() {
352 return self::getFallbacksFor( $this->mCode );
353 }
354
355 /**
356 * Exports $wgBookstoreListEn
357 * @return array
358 */
359 function getBookstoreList() {
360 return self::$dataCache->getItem( $this->mCode, 'bookstoreList' );
361 }
362
363 /**
364 * @return array
365 */
366 public function getNamespaces() {
367 if ( is_null( $this->namespaceNames ) ) {
368 global $wgMetaNamespace, $wgMetaNamespaceTalk, $wgExtraNamespaces;
369
370 $this->namespaceNames = self::$dataCache->getItem( $this->mCode, 'namespaceNames' );
371 $validNamespaces = MWNamespace::getCanonicalNamespaces();
372
373 $this->namespaceNames = $wgExtraNamespaces + $this->namespaceNames + $validNamespaces;
374
375 $this->namespaceNames[NS_PROJECT] = $wgMetaNamespace;
376 if ( $wgMetaNamespaceTalk ) {
377 $this->namespaceNames[NS_PROJECT_TALK] = $wgMetaNamespaceTalk;
378 } else {
379 $talk = $this->namespaceNames[NS_PROJECT_TALK];
380 $this->namespaceNames[NS_PROJECT_TALK] =
381 $this->fixVariableInNamespace( $talk );
382 }
383
384 # Sometimes a language will be localised but not actually exist on this wiki.
385 foreach ( $this->namespaceNames as $key => $text ) {
386 if ( !isset( $validNamespaces[$key] ) ) {
387 unset( $this->namespaceNames[$key] );
388 }
389 }
390
391 # The above mixing may leave namespaces out of canonical order.
392 # Re-order by namespace ID number...
393 ksort( $this->namespaceNames );
394
395 wfRunHooks( 'LanguageGetNamespaces', array( &$this->namespaceNames ) );
396 }
397 return $this->namespaceNames;
398 }
399
400 /**
401 * Arbitrarily set all of the namespace names at once. Mainly used for testing
402 * @param $namespaces Array of namespaces (id => name)
403 */
404 public function setNamespaces( array $namespaces ) {
405 $this->namespaceNames = $namespaces;
406 }
407
408 /**
409 * A convenience function that returns the same thing as
410 * getNamespaces() except with the array values changed to ' '
411 * where it found '_', useful for producing output to be displayed
412 * e.g. in <select> forms.
413 *
414 * @return array
415 */
416 function getFormattedNamespaces() {
417 $ns = $this->getNamespaces();
418 foreach ( $ns as $k => $v ) {
419 $ns[$k] = strtr( $v, '_', ' ' );
420 }
421 return $ns;
422 }
423
424 /**
425 * Get a namespace value by key
426 * <code>
427 * $mw_ns = $wgContLang->getNsText( NS_MEDIAWIKI );
428 * echo $mw_ns; // prints 'MediaWiki'
429 * </code>
430 *
431 * @param $index Int: the array key of the namespace to return
432 * @return mixed, string if the namespace value exists, otherwise false
433 */
434 function getNsText( $index ) {
435 $ns = $this->getNamespaces();
436 return isset( $ns[$index] ) ? $ns[$index] : false;
437 }
438
439 /**
440 * A convenience function that returns the same thing as
441 * getNsText() except with '_' changed to ' ', useful for
442 * producing output.
443 *
444 * @param $index string
445 *
446 * @return array
447 */
448 function getFormattedNsText( $index ) {
449 $ns = $this->getNsText( $index );
450 return strtr( $ns, '_', ' ' );
451 }
452
453 /**
454 * Returns gender-dependent namespace alias if available.
455 * @param $index Int: namespace index
456 * @param $gender String: gender key (male, female... )
457 * @return String
458 * @since 1.18
459 */
460 function getGenderNsText( $index, $gender ) {
461 global $wgExtraGenderNamespaces;
462
463 $ns = $wgExtraGenderNamespaces + self::$dataCache->getItem( $this->mCode, 'namespaceGenderAliases' );
464 return isset( $ns[$index][$gender] ) ? $ns[$index][$gender] : $this->getNsText( $index );
465 }
466
467 /**
468 * Whether this language makes distinguishes genders for example in
469 * namespaces.
470 * @return bool
471 * @since 1.18
472 */
473 function needsGenderDistinction() {
474 global $wgExtraGenderNamespaces, $wgExtraNamespaces;
475 if ( count( $wgExtraGenderNamespaces ) > 0 ) {
476 // $wgExtraGenderNamespaces overrides everything
477 return true;
478 } elseif ( isset( $wgExtraNamespaces[NS_USER] ) && isset( $wgExtraNamespaces[NS_USER_TALK] ) ) {
479 /// @todo There may be other gender namespace than NS_USER & NS_USER_TALK in the future
480 // $wgExtraNamespaces overrides any gender aliases specified in i18n files
481 return false;
482 } else {
483 // Check what is in i18n files
484 $aliases = self::$dataCache->getItem( $this->mCode, 'namespaceGenderAliases' );
485 return count( $aliases ) > 0;
486 }
487 }
488
489 /**
490 * Get a namespace key by value, case insensitive.
491 * Only matches namespace names for the current language, not the
492 * canonical ones defined in Namespace.php.
493 *
494 * @param $text String
495 * @return mixed An integer if $text is a valid value otherwise false
496 */
497 function getLocalNsIndex( $text ) {
498 $lctext = $this->lc( $text );
499 $ids = $this->getNamespaceIds();
500 return isset( $ids[$lctext] ) ? $ids[$lctext] : false;
501 }
502
503 /**
504 * @return array
505 */
506 function getNamespaceAliases() {
507 if ( is_null( $this->namespaceAliases ) ) {
508 $aliases = self::$dataCache->getItem( $this->mCode, 'namespaceAliases' );
509 if ( !$aliases ) {
510 $aliases = array();
511 } else {
512 foreach ( $aliases as $name => $index ) {
513 if ( $index === NS_PROJECT_TALK ) {
514 unset( $aliases[$name] );
515 $name = $this->fixVariableInNamespace( $name );
516 $aliases[$name] = $index;
517 }
518 }
519 }
520
521 global $wgExtraGenderNamespaces;
522 $genders = $wgExtraGenderNamespaces + (array)self::$dataCache->getItem( $this->mCode, 'namespaceGenderAliases' );
523 foreach ( $genders as $index => $forms ) {
524 foreach ( $forms as $alias ) {
525 $aliases[$alias] = $index;
526 }
527 }
528
529 $this->namespaceAliases = $aliases;
530 }
531 return $this->namespaceAliases;
532 }
533
534 /**
535 * @return array
536 */
537 function getNamespaceIds() {
538 if ( is_null( $this->mNamespaceIds ) ) {
539 global $wgNamespaceAliases;
540 # Put namespace names and aliases into a hashtable.
541 # If this is too slow, then we should arrange it so that it is done
542 # before caching. The catch is that at pre-cache time, the above
543 # class-specific fixup hasn't been done.
544 $this->mNamespaceIds = array();
545 foreach ( $this->getNamespaces() as $index => $name ) {
546 $this->mNamespaceIds[$this->lc( $name )] = $index;
547 }
548 foreach ( $this->getNamespaceAliases() as $name => $index ) {
549 $this->mNamespaceIds[$this->lc( $name )] = $index;
550 }
551 if ( $wgNamespaceAliases ) {
552 foreach ( $wgNamespaceAliases as $name => $index ) {
553 $this->mNamespaceIds[$this->lc( $name )] = $index;
554 }
555 }
556 }
557 return $this->mNamespaceIds;
558 }
559
560 /**
561 * Get a namespace key by value, case insensitive. Canonical namespace
562 * names override custom ones defined for the current language.
563 *
564 * @param $text String
565 * @return mixed An integer if $text is a valid value otherwise false
566 */
567 function getNsIndex( $text ) {
568 $lctext = $this->lc( $text );
569 $ns = MWNamespace::getCanonicalIndex( $lctext );
570 if ( $ns !== null ) {
571 return $ns;
572 }
573 $ids = $this->getNamespaceIds();
574 return isset( $ids[$lctext] ) ? $ids[$lctext] : false;
575 }
576
577 /**
578 * short names for language variants used for language conversion links.
579 *
580 * @param $code String
581 * @param $usemsg bool Use the "variantname-xyz" message if it exists
582 * @return string
583 */
584 function getVariantname( $code, $usemsg = true ) {
585 $msg = "variantname-$code";
586 if ( $usemsg && wfMessage( $msg )->exists() ) {
587 return $this->getMessageFromDB( $msg );
588 }
589 $name = self::fetchLanguageName( $code );
590 if ( $name ) {
591 return $name; # if it's defined as a language name, show that
592 } else {
593 # otherwise, output the language code
594 return $code;
595 }
596 }
597
598 /**
599 * @param $name string
600 * @return string
601 */
602 function specialPage( $name ) {
603 $aliases = $this->getSpecialPageAliases();
604 if ( isset( $aliases[$name][0] ) ) {
605 $name = $aliases[$name][0];
606 }
607 return $this->getNsText( NS_SPECIAL ) . ':' . $name;
608 }
609
610 /**
611 * @return array
612 */
613 function getQuickbarSettings() {
614 return array(
615 $this->getMessage( 'qbsettings-none' ),
616 $this->getMessage( 'qbsettings-fixedleft' ),
617 $this->getMessage( 'qbsettings-fixedright' ),
618 $this->getMessage( 'qbsettings-floatingleft' ),
619 $this->getMessage( 'qbsettings-floatingright' ),
620 $this->getMessage( 'qbsettings-directionality' )
621 );
622 }
623
624 /**
625 * @return array
626 */
627 function getDatePreferences() {
628 return self::$dataCache->getItem( $this->mCode, 'datePreferences' );
629 }
630
631 /**
632 * @return array
633 */
634 function getDateFormats() {
635 return self::$dataCache->getItem( $this->mCode, 'dateFormats' );
636 }
637
638 /**
639 * @return array|string
640 */
641 function getDefaultDateFormat() {
642 $df = self::$dataCache->getItem( $this->mCode, 'defaultDateFormat' );
643 if ( $df === 'dmy or mdy' ) {
644 global $wgAmericanDates;
645 return $wgAmericanDates ? 'mdy' : 'dmy';
646 } else {
647 return $df;
648 }
649 }
650
651 /**
652 * @return array
653 */
654 function getDatePreferenceMigrationMap() {
655 return self::$dataCache->getItem( $this->mCode, 'datePreferenceMigrationMap' );
656 }
657
658 /**
659 * @param $image
660 * @return array|null
661 */
662 function getImageFile( $image ) {
663 return self::$dataCache->getSubitem( $this->mCode, 'imageFiles', $image );
664 }
665
666 /**
667 * @return array
668 */
669 function getExtraUserToggles() {
670 return (array)self::$dataCache->getItem( $this->mCode, 'extraUserToggles' );
671 }
672
673 /**
674 * @param $tog
675 * @return string
676 */
677 function getUserToggle( $tog ) {
678 return $this->getMessageFromDB( "tog-$tog" );
679 }
680
681 /**
682 * Get native language names, indexed by code.
683 * Only those defined in MediaWiki, no other data like CLDR.
684 * If $customisedOnly is true, only returns codes with a messages file
685 *
686 * @param $customisedOnly bool
687 *
688 * @return array
689 * @deprecated in 1.20, use fetchLanguageNames()
690 */
691 public static function getLanguageNames( $customisedOnly = false ) {
692 return self::fetchLanguageNames( null, $customisedOnly ? 'mwfile' : 'mw' );
693 }
694
695 /**
696 * Get translated language names. This is done on best effort and
697 * by default this is exactly the same as Language::getLanguageNames.
698 * The CLDR extension provides translated names.
699 * @param $code String Language code.
700 * @return Array language code => language name
701 * @since 1.18.0
702 * @deprecated in 1.20, use fetchLanguageNames()
703 */
704 public static function getTranslatedLanguageNames( $code ) {
705 return self::fetchLanguageNames( $code, 'all' );
706 }
707
708 /**
709 * Get an array of language names, indexed by code.
710 * @param $inLanguage null|string: Code of language in which to return the names
711 * Use null for autonyms (native names)
712 * @param $include string:
713 * 'all' all available languages
714 * 'mw' only if the language is defined in MediaWiki or wgExtraLanguageNames (default)
715 * 'mwfile' only if the language is in 'mw' *and* has a message file
716 * @return array: language code => language name
717 * @since 1.20
718 */
719 public static function fetchLanguageNames( $inLanguage = null, $include = 'mw' ) {
720 global $wgExtraLanguageNames;
721 static $coreLanguageNames;
722
723 if ( $coreLanguageNames === null ) {
724 include( MWInit::compiledPath( 'languages/Names.php' ) );
725 }
726
727 $names = array();
728
729 if( $inLanguage ) {
730 # TODO: also include when $inLanguage is null, when this code is more efficient
731 wfRunHooks( 'LanguageGetTranslatedLanguageNames', array( &$names, $inLanguage ) );
732 }
733
734 $mwNames = $wgExtraLanguageNames + $coreLanguageNames;
735 foreach ( $mwNames as $mwCode => $mwName ) {
736 # - Prefer own MediaWiki native name when not using the hook
737 # - For other names just add if not added through the hook
738 if ( $mwCode === $inLanguage || !isset( $names[$mwCode] ) ) {
739 $names[$mwCode] = $mwName;
740 }
741 }
742
743 if ( $include === 'all' ) {
744 return $names;
745 }
746
747 $returnMw = array();
748 $coreCodes = array_keys( $mwNames );
749 foreach( $coreCodes as $coreCode ) {
750 $returnMw[$coreCode] = $names[$coreCode];
751 }
752
753 if( $include === 'mwfile' ) {
754 $namesMwFile = array();
755 # We do this using a foreach over the codes instead of a directory
756 # loop so that messages files in extensions will work correctly.
757 foreach ( $returnMw as $code => $value ) {
758 if ( is_readable( self::getMessagesFileName( $code ) ) ) {
759 $namesMwFile[$code] = $names[$code];
760 }
761 }
762 return $namesMwFile;
763 }
764 # 'mw' option; default if it's not one of the other two options (all/mwfile)
765 return $returnMw;
766 }
767
768 /**
769 * @param $code string: The code of the language for which to get the name
770 * @param $inLanguage null|string: Code of language in which to return the name (null for autonyms)
771 * @param $include string: 'all', 'mw' or 'mwfile'; see fetchLanguageNames()
772 * @return string: Language name or empty
773 * @since 1.20
774 */
775 public static function fetchLanguageName( $code, $inLanguage = null, $include = 'all' ) {
776 $array = self::fetchLanguageNames( $inLanguage, $include );
777 return !array_key_exists( $code, $array ) ? '' : $array[$code];
778 }
779
780 /**
781 * Get a message from the MediaWiki namespace.
782 *
783 * @param $msg String: message name
784 * @return string
785 */
786 function getMessageFromDB( $msg ) {
787 return wfMsgExt( $msg, array( 'parsemag', 'language' => $this ) );
788 }
789
790 /**
791 * Get the native language name of $code.
792 * Only if defined in MediaWiki, no other data like CLDR.
793 * @param $code string
794 * @return string
795 * @deprecated in 1.20, use fetchLanguageName()
796 */
797 function getLanguageName( $code ) {
798 return self::fetchLanguageName( $code );
799 }
800
801 /**
802 * @param $key string
803 * @return string
804 */
805 function getMonthName( $key ) {
806 return $this->getMessageFromDB( self::$mMonthMsgs[$key - 1] );
807 }
808
809 /**
810 * @return array
811 */
812 function getMonthNamesArray() {
813 $monthNames = array( '' );
814 for ( $i = 1; $i < 13; $i++ ) {
815 $monthNames[] = $this->getMonthName( $i );
816 }
817 return $monthNames;
818 }
819
820 /**
821 * @param $key string
822 * @return string
823 */
824 function getMonthNameGen( $key ) {
825 return $this->getMessageFromDB( self::$mMonthGenMsgs[$key - 1] );
826 }
827
828 /**
829 * @param $key string
830 * @return string
831 */
832 function getMonthAbbreviation( $key ) {
833 return $this->getMessageFromDB( self::$mMonthAbbrevMsgs[$key - 1] );
834 }
835
836 /**
837 * @return array
838 */
839 function getMonthAbbreviationsArray() {
840 $monthNames = array( '' );
841 for ( $i = 1; $i < 13; $i++ ) {
842 $monthNames[] = $this->getMonthAbbreviation( $i );
843 }
844 return $monthNames;
845 }
846
847 /**
848 * @param $key string
849 * @return string
850 */
851 function getWeekdayName( $key ) {
852 return $this->getMessageFromDB( self::$mWeekdayMsgs[$key - 1] );
853 }
854
855 /**
856 * @param $key string
857 * @return string
858 */
859 function getWeekdayAbbreviation( $key ) {
860 return $this->getMessageFromDB( self::$mWeekdayAbbrevMsgs[$key - 1] );
861 }
862
863 /**
864 * @param $key string
865 * @return string
866 */
867 function getIranianCalendarMonthName( $key ) {
868 return $this->getMessageFromDB( self::$mIranianCalendarMonthMsgs[$key - 1] );
869 }
870
871 /**
872 * @param $key string
873 * @return string
874 */
875 function getHebrewCalendarMonthName( $key ) {
876 return $this->getMessageFromDB( self::$mHebrewCalendarMonthMsgs[$key - 1] );
877 }
878
879 /**
880 * @param $key string
881 * @return string
882 */
883 function getHebrewCalendarMonthNameGen( $key ) {
884 return $this->getMessageFromDB( self::$mHebrewCalendarMonthGenMsgs[$key - 1] );
885 }
886
887 /**
888 * @param $key string
889 * @return string
890 */
891 function getHijriCalendarMonthName( $key ) {
892 return $this->getMessageFromDB( self::$mHijriCalendarMonthMsgs[$key - 1] );
893 }
894
895 /**
896 * This is a workalike of PHP's date() function, but with better
897 * internationalisation, a reduced set of format characters, and a better
898 * escaping format.
899 *
900 * Supported format characters are dDjlNwzWFmMntLoYyaAgGhHiscrU. See the
901 * PHP manual for definitions. There are a number of extensions, which
902 * start with "x":
903 *
904 * xn Do not translate digits of the next numeric format character
905 * xN Toggle raw digit (xn) flag, stays set until explicitly unset
906 * xr Use roman numerals for the next numeric format character
907 * xh Use hebrew numerals for the next numeric format character
908 * xx Literal x
909 * xg Genitive month name
910 *
911 * xij j (day number) in Iranian calendar
912 * xiF F (month name) in Iranian calendar
913 * xin n (month number) in Iranian calendar
914 * xiy y (two digit year) in Iranian calendar
915 * xiY Y (full year) in Iranian calendar
916 *
917 * xjj j (day number) in Hebrew calendar
918 * xjF F (month name) in Hebrew calendar
919 * xjt t (days in month) in Hebrew calendar
920 * xjx xg (genitive month name) in Hebrew calendar
921 * xjn n (month number) in Hebrew calendar
922 * xjY Y (full year) in Hebrew calendar
923 *
924 * xmj j (day number) in Hijri calendar
925 * xmF F (month name) in Hijri calendar
926 * xmn n (month number) in Hijri calendar
927 * xmY Y (full year) in Hijri calendar
928 *
929 * xkY Y (full year) in Thai solar calendar. Months and days are
930 * identical to the Gregorian calendar
931 * xoY Y (full year) in Minguo calendar or Juche year.
932 * Months and days are identical to the
933 * Gregorian calendar
934 * xtY Y (full year) in Japanese nengo. Months and days are
935 * identical to the Gregorian calendar
936 *
937 * Characters enclosed in double quotes will be considered literal (with
938 * the quotes themselves removed). Unmatched quotes will be considered
939 * literal quotes. Example:
940 *
941 * "The month is" F => The month is January
942 * i's" => 20'11"
943 *
944 * Backslash escaping is also supported.
945 *
946 * Input timestamp is assumed to be pre-normalized to the desired local
947 * time zone, if any.
948 *
949 * @param $format String
950 * @param $ts String: 14-character timestamp
951 * YYYYMMDDHHMMSS
952 * 01234567890123
953 * @todo handling of "o" format character for Iranian, Hebrew, Hijri & Thai?
954 *
955 * @return string
956 */
957 function sprintfDate( $format, $ts ) {
958 $s = '';
959 $raw = false;
960 $roman = false;
961 $hebrewNum = false;
962 $unix = false;
963 $rawToggle = false;
964 $iranian = false;
965 $hebrew = false;
966 $hijri = false;
967 $thai = false;
968 $minguo = false;
969 $tenno = false;
970 for ( $p = 0; $p < strlen( $format ); $p++ ) {
971 $num = false;
972 $code = $format[$p];
973 if ( $code == 'x' && $p < strlen( $format ) - 1 ) {
974 $code .= $format[++$p];
975 }
976
977 if ( ( $code === 'xi' || $code == 'xj' || $code == 'xk' || $code == 'xm' || $code == 'xo' || $code == 'xt' ) && $p < strlen( $format ) - 1 ) {
978 $code .= $format[++$p];
979 }
980
981 switch ( $code ) {
982 case 'xx':
983 $s .= 'x';
984 break;
985 case 'xn':
986 $raw = true;
987 break;
988 case 'xN':
989 $rawToggle = !$rawToggle;
990 break;
991 case 'xr':
992 $roman = true;
993 break;
994 case 'xh':
995 $hebrewNum = true;
996 break;
997 case 'xg':
998 $s .= $this->getMonthNameGen( substr( $ts, 4, 2 ) );
999 break;
1000 case 'xjx':
1001 if ( !$hebrew ) $hebrew = self::tsToHebrew( $ts );
1002 $s .= $this->getHebrewCalendarMonthNameGen( $hebrew[1] );
1003 break;
1004 case 'd':
1005 $num = substr( $ts, 6, 2 );
1006 break;
1007 case 'D':
1008 if ( !$unix ) $unix = wfTimestamp( TS_UNIX, $ts );
1009 $s .= $this->getWeekdayAbbreviation( gmdate( 'w', $unix ) + 1 );
1010 break;
1011 case 'j':
1012 $num = intval( substr( $ts, 6, 2 ) );
1013 break;
1014 case 'xij':
1015 if ( !$iranian ) {
1016 $iranian = self::tsToIranian( $ts );
1017 }
1018 $num = $iranian[2];
1019 break;
1020 case 'xmj':
1021 if ( !$hijri ) {
1022 $hijri = self::tsToHijri( $ts );
1023 }
1024 $num = $hijri[2];
1025 break;
1026 case 'xjj':
1027 if ( !$hebrew ) {
1028 $hebrew = self::tsToHebrew( $ts );
1029 }
1030 $num = $hebrew[2];
1031 break;
1032 case 'l':
1033 if ( !$unix ) {
1034 $unix = wfTimestamp( TS_UNIX, $ts );
1035 }
1036 $s .= $this->getWeekdayName( gmdate( 'w', $unix ) + 1 );
1037 break;
1038 case 'N':
1039 if ( !$unix ) {
1040 $unix = wfTimestamp( TS_UNIX, $ts );
1041 }
1042 $w = gmdate( 'w', $unix );
1043 $num = $w ? $w : 7;
1044 break;
1045 case 'w':
1046 if ( !$unix ) {
1047 $unix = wfTimestamp( TS_UNIX, $ts );
1048 }
1049 $num = gmdate( 'w', $unix );
1050 break;
1051 case 'z':
1052 if ( !$unix ) {
1053 $unix = wfTimestamp( TS_UNIX, $ts );
1054 }
1055 $num = gmdate( 'z', $unix );
1056 break;
1057 case 'W':
1058 if ( !$unix ) {
1059 $unix = wfTimestamp( TS_UNIX, $ts );
1060 }
1061 $num = gmdate( 'W', $unix );
1062 break;
1063 case 'F':
1064 $s .= $this->getMonthName( substr( $ts, 4, 2 ) );
1065 break;
1066 case 'xiF':
1067 if ( !$iranian ) {
1068 $iranian = self::tsToIranian( $ts );
1069 }
1070 $s .= $this->getIranianCalendarMonthName( $iranian[1] );
1071 break;
1072 case 'xmF':
1073 if ( !$hijri ) {
1074 $hijri = self::tsToHijri( $ts );
1075 }
1076 $s .= $this->getHijriCalendarMonthName( $hijri[1] );
1077 break;
1078 case 'xjF':
1079 if ( !$hebrew ) {
1080 $hebrew = self::tsToHebrew( $ts );
1081 }
1082 $s .= $this->getHebrewCalendarMonthName( $hebrew[1] );
1083 break;
1084 case 'm':
1085 $num = substr( $ts, 4, 2 );
1086 break;
1087 case 'M':
1088 $s .= $this->getMonthAbbreviation( substr( $ts, 4, 2 ) );
1089 break;
1090 case 'n':
1091 $num = intval( substr( $ts, 4, 2 ) );
1092 break;
1093 case 'xin':
1094 if ( !$iranian ) {
1095 $iranian = self::tsToIranian( $ts );
1096 }
1097 $num = $iranian[1];
1098 break;
1099 case 'xmn':
1100 if ( !$hijri ) {
1101 $hijri = self::tsToHijri ( $ts );
1102 }
1103 $num = $hijri[1];
1104 break;
1105 case 'xjn':
1106 if ( !$hebrew ) {
1107 $hebrew = self::tsToHebrew( $ts );
1108 }
1109 $num = $hebrew[1];
1110 break;
1111 case 't':
1112 if ( !$unix ) {
1113 $unix = wfTimestamp( TS_UNIX, $ts );
1114 }
1115 $num = gmdate( 't', $unix );
1116 break;
1117 case 'xjt':
1118 if ( !$hebrew ) {
1119 $hebrew = self::tsToHebrew( $ts );
1120 }
1121 $num = $hebrew[3];
1122 break;
1123 case 'L':
1124 if ( !$unix ) {
1125 $unix = wfTimestamp( TS_UNIX, $ts );
1126 }
1127 $num = gmdate( 'L', $unix );
1128 break;
1129 case 'o':
1130 if ( !$unix ) {
1131 $unix = wfTimestamp( TS_UNIX, $ts );
1132 }
1133 $num = gmdate( 'o', $unix );
1134 break;
1135 case 'Y':
1136 $num = substr( $ts, 0, 4 );
1137 break;
1138 case 'xiY':
1139 if ( !$iranian ) {
1140 $iranian = self::tsToIranian( $ts );
1141 }
1142 $num = $iranian[0];
1143 break;
1144 case 'xmY':
1145 if ( !$hijri ) {
1146 $hijri = self::tsToHijri( $ts );
1147 }
1148 $num = $hijri[0];
1149 break;
1150 case 'xjY':
1151 if ( !$hebrew ) {
1152 $hebrew = self::tsToHebrew( $ts );
1153 }
1154 $num = $hebrew[0];
1155 break;
1156 case 'xkY':
1157 if ( !$thai ) {
1158 $thai = self::tsToYear( $ts, 'thai' );
1159 }
1160 $num = $thai[0];
1161 break;
1162 case 'xoY':
1163 if ( !$minguo ) {
1164 $minguo = self::tsToYear( $ts, 'minguo' );
1165 }
1166 $num = $minguo[0];
1167 break;
1168 case 'xtY':
1169 if ( !$tenno ) {
1170 $tenno = self::tsToYear( $ts, 'tenno' );
1171 }
1172 $num = $tenno[0];
1173 break;
1174 case 'y':
1175 $num = substr( $ts, 2, 2 );
1176 break;
1177 case 'xiy':
1178 if ( !$iranian ) {
1179 $iranian = self::tsToIranian( $ts );
1180 }
1181 $num = substr( $iranian[0], -2 );
1182 break;
1183 case 'a':
1184 $s .= intval( substr( $ts, 8, 2 ) ) < 12 ? 'am' : 'pm';
1185 break;
1186 case 'A':
1187 $s .= intval( substr( $ts, 8, 2 ) ) < 12 ? 'AM' : 'PM';
1188 break;
1189 case 'g':
1190 $h = substr( $ts, 8, 2 );
1191 $num = $h % 12 ? $h % 12 : 12;
1192 break;
1193 case 'G':
1194 $num = intval( substr( $ts, 8, 2 ) );
1195 break;
1196 case 'h':
1197 $h = substr( $ts, 8, 2 );
1198 $num = sprintf( '%02d', $h % 12 ? $h % 12 : 12 );
1199 break;
1200 case 'H':
1201 $num = substr( $ts, 8, 2 );
1202 break;
1203 case 'i':
1204 $num = substr( $ts, 10, 2 );
1205 break;
1206 case 's':
1207 $num = substr( $ts, 12, 2 );
1208 break;
1209 case 'c':
1210 if ( !$unix ) {
1211 $unix = wfTimestamp( TS_UNIX, $ts );
1212 }
1213 $s .= gmdate( 'c', $unix );
1214 break;
1215 case 'r':
1216 if ( !$unix ) {
1217 $unix = wfTimestamp( TS_UNIX, $ts );
1218 }
1219 $s .= gmdate( 'r', $unix );
1220 break;
1221 case 'U':
1222 if ( !$unix ) {
1223 $unix = wfTimestamp( TS_UNIX, $ts );
1224 }
1225 $num = $unix;
1226 break;
1227 case '\\':
1228 # Backslash escaping
1229 if ( $p < strlen( $format ) - 1 ) {
1230 $s .= $format[++$p];
1231 } else {
1232 $s .= '\\';
1233 }
1234 break;
1235 case '"':
1236 # Quoted literal
1237 if ( $p < strlen( $format ) - 1 ) {
1238 $endQuote = strpos( $format, '"', $p + 1 );
1239 if ( $endQuote === false ) {
1240 # No terminating quote, assume literal "
1241 $s .= '"';
1242 } else {
1243 $s .= substr( $format, $p + 1, $endQuote - $p - 1 );
1244 $p = $endQuote;
1245 }
1246 } else {
1247 # Quote at end of string, assume literal "
1248 $s .= '"';
1249 }
1250 break;
1251 default:
1252 $s .= $format[$p];
1253 }
1254 if ( $num !== false ) {
1255 if ( $rawToggle || $raw ) {
1256 $s .= $num;
1257 $raw = false;
1258 } elseif ( $roman ) {
1259 $s .= self::romanNumeral( $num );
1260 $roman = false;
1261 } elseif ( $hebrewNum ) {
1262 $s .= self::hebrewNumeral( $num );
1263 $hebrewNum = false;
1264 } else {
1265 $s .= $this->formatNum( $num, true );
1266 }
1267 }
1268 }
1269 return $s;
1270 }
1271
1272 private static $GREG_DAYS = array( 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 );
1273 private static $IRANIAN_DAYS = array( 31, 31, 31, 31, 31, 31, 30, 30, 30, 30, 30, 29 );
1274
1275 /**
1276 * Algorithm by Roozbeh Pournader and Mohammad Toossi to convert
1277 * Gregorian dates to Iranian dates. Originally written in C, it
1278 * is released under the terms of GNU Lesser General Public
1279 * License. Conversion to PHP was performed by Niklas Laxström.
1280 *
1281 * Link: http://www.farsiweb.info/jalali/jalali.c
1282 *
1283 * @param $ts string
1284 *
1285 * @return string
1286 */
1287 private static function tsToIranian( $ts ) {
1288 $gy = substr( $ts, 0, 4 ) -1600;
1289 $gm = substr( $ts, 4, 2 ) -1;
1290 $gd = substr( $ts, 6, 2 ) -1;
1291
1292 # Days passed from the beginning (including leap years)
1293 $gDayNo = 365 * $gy
1294 + floor( ( $gy + 3 ) / 4 )
1295 - floor( ( $gy + 99 ) / 100 )
1296 + floor( ( $gy + 399 ) / 400 );
1297
1298 // Add days of the past months of this year
1299 for ( $i = 0; $i < $gm; $i++ ) {
1300 $gDayNo += self::$GREG_DAYS[$i];
1301 }
1302
1303 // Leap years
1304 if ( $gm > 1 && ( ( $gy % 4 === 0 && $gy % 100 !== 0 || ( $gy % 400 == 0 ) ) ) ) {
1305 $gDayNo++;
1306 }
1307
1308 // Days passed in current month
1309 $gDayNo += (int)$gd;
1310
1311 $jDayNo = $gDayNo - 79;
1312
1313 $jNp = floor( $jDayNo / 12053 );
1314 $jDayNo %= 12053;
1315
1316 $jy = 979 + 33 * $jNp + 4 * floor( $jDayNo / 1461 );
1317 $jDayNo %= 1461;
1318
1319 if ( $jDayNo >= 366 ) {
1320 $jy += floor( ( $jDayNo - 1 ) / 365 );
1321 $jDayNo = floor( ( $jDayNo - 1 ) % 365 );
1322 }
1323
1324 for ( $i = 0; $i < 11 && $jDayNo >= self::$IRANIAN_DAYS[$i]; $i++ ) {
1325 $jDayNo -= self::$IRANIAN_DAYS[$i];
1326 }
1327
1328 $jm = $i + 1;
1329 $jd = $jDayNo + 1;
1330
1331 return array( $jy, $jm, $jd );
1332 }
1333
1334 /**
1335 * Converting Gregorian dates to Hijri dates.
1336 *
1337 * Based on a PHP-Nuke block by Sharjeel which is released under GNU/GPL license
1338 *
1339 * @see http://phpnuke.org/modules.php?name=News&file=article&sid=8234&mode=thread&order=0&thold=0
1340 *
1341 * @param $ts string
1342 *
1343 * @return string
1344 */
1345 private static function tsToHijri( $ts ) {
1346 $year = substr( $ts, 0, 4 );
1347 $month = substr( $ts, 4, 2 );
1348 $day = substr( $ts, 6, 2 );
1349
1350 $zyr = $year;
1351 $zd = $day;
1352 $zm = $month;
1353 $zy = $zyr;
1354
1355 if (
1356 ( $zy > 1582 ) || ( ( $zy == 1582 ) && ( $zm > 10 ) ) ||
1357 ( ( $zy == 1582 ) && ( $zm == 10 ) && ( $zd > 14 ) )
1358 )
1359 {
1360 $zjd = (int)( ( 1461 * ( $zy + 4800 + (int)( ( $zm - 14 ) / 12 ) ) ) / 4 ) +
1361 (int)( ( 367 * ( $zm - 2 - 12 * ( (int)( ( $zm - 14 ) / 12 ) ) ) ) / 12 ) -
1362 (int)( ( 3 * (int)( ( ( $zy + 4900 + (int)( ( $zm - 14 ) / 12 ) ) / 100 ) ) ) / 4 ) +
1363 $zd - 32075;
1364 } else {
1365 $zjd = 367 * $zy - (int)( ( 7 * ( $zy + 5001 + (int)( ( $zm - 9 ) / 7 ) ) ) / 4 ) +
1366 (int)( ( 275 * $zm ) / 9 ) + $zd + 1729777;
1367 }
1368
1369 $zl = $zjd -1948440 + 10632;
1370 $zn = (int)( ( $zl - 1 ) / 10631 );
1371 $zl = $zl - 10631 * $zn + 354;
1372 $zj = ( (int)( ( 10985 - $zl ) / 5316 ) ) * ( (int)( ( 50 * $zl ) / 17719 ) ) + ( (int)( $zl / 5670 ) ) * ( (int)( ( 43 * $zl ) / 15238 ) );
1373 $zl = $zl - ( (int)( ( 30 - $zj ) / 15 ) ) * ( (int)( ( 17719 * $zj ) / 50 ) ) - ( (int)( $zj / 16 ) ) * ( (int)( ( 15238 * $zj ) / 43 ) ) + 29;
1374 $zm = (int)( ( 24 * $zl ) / 709 );
1375 $zd = $zl - (int)( ( 709 * $zm ) / 24 );
1376 $zy = 30 * $zn + $zj - 30;
1377
1378 return array( $zy, $zm, $zd );
1379 }
1380
1381 /**
1382 * Converting Gregorian dates to Hebrew dates.
1383 *
1384 * Based on a JavaScript code by Abu Mami and Yisrael Hersch
1385 * (abu-mami@kaluach.net, http://www.kaluach.net), who permitted
1386 * to translate the relevant functions into PHP and release them under
1387 * GNU GPL.
1388 *
1389 * The months are counted from Tishrei = 1. In a leap year, Adar I is 13
1390 * and Adar II is 14. In a non-leap year, Adar is 6.
1391 *
1392 * @param $ts string
1393 *
1394 * @return string
1395 */
1396 private static function tsToHebrew( $ts ) {
1397 # Parse date
1398 $year = substr( $ts, 0, 4 );
1399 $month = substr( $ts, 4, 2 );
1400 $day = substr( $ts, 6, 2 );
1401
1402 # Calculate Hebrew year
1403 $hebrewYear = $year + 3760;
1404
1405 # Month number when September = 1, August = 12
1406 $month += 4;
1407 if ( $month > 12 ) {
1408 # Next year
1409 $month -= 12;
1410 $year++;
1411 $hebrewYear++;
1412 }
1413
1414 # Calculate day of year from 1 September
1415 $dayOfYear = $day;
1416 for ( $i = 1; $i < $month; $i++ ) {
1417 if ( $i == 6 ) {
1418 # February
1419 $dayOfYear += 28;
1420 # Check if the year is leap
1421 if ( $year % 400 == 0 || ( $year % 4 == 0 && $year % 100 > 0 ) ) {
1422 $dayOfYear++;
1423 }
1424 } elseif ( $i == 8 || $i == 10 || $i == 1 || $i == 3 ) {
1425 $dayOfYear += 30;
1426 } else {
1427 $dayOfYear += 31;
1428 }
1429 }
1430
1431 # Calculate the start of the Hebrew year
1432 $start = self::hebrewYearStart( $hebrewYear );
1433
1434 # Calculate next year's start
1435 if ( $dayOfYear <= $start ) {
1436 # Day is before the start of the year - it is the previous year
1437 # Next year's start
1438 $nextStart = $start;
1439 # Previous year
1440 $year--;
1441 $hebrewYear--;
1442 # Add days since previous year's 1 September
1443 $dayOfYear += 365;
1444 if ( ( $year % 400 == 0 ) || ( $year % 100 != 0 && $year % 4 == 0 ) ) {
1445 # Leap year
1446 $dayOfYear++;
1447 }
1448 # Start of the new (previous) year
1449 $start = self::hebrewYearStart( $hebrewYear );
1450 } else {
1451 # Next year's start
1452 $nextStart = self::hebrewYearStart( $hebrewYear + 1 );
1453 }
1454
1455 # Calculate Hebrew day of year
1456 $hebrewDayOfYear = $dayOfYear - $start;
1457
1458 # Difference between year's days
1459 $diff = $nextStart - $start;
1460 # Add 12 (or 13 for leap years) days to ignore the difference between
1461 # Hebrew and Gregorian year (353 at least vs. 365/6) - now the
1462 # difference is only about the year type
1463 if ( ( $year % 400 == 0 ) || ( $year % 100 != 0 && $year % 4 == 0 ) ) {
1464 $diff += 13;
1465 } else {
1466 $diff += 12;
1467 }
1468
1469 # Check the year pattern, and is leap year
1470 # 0 means an incomplete year, 1 means a regular year, 2 means a complete year
1471 # This is mod 30, to work on both leap years (which add 30 days of Adar I)
1472 # and non-leap years
1473 $yearPattern = $diff % 30;
1474 # Check if leap year
1475 $isLeap = $diff >= 30;
1476
1477 # Calculate day in the month from number of day in the Hebrew year
1478 # Don't check Adar - if the day is not in Adar, we will stop before;
1479 # if it is in Adar, we will use it to check if it is Adar I or Adar II
1480 $hebrewDay = $hebrewDayOfYear;
1481 $hebrewMonth = 1;
1482 $days = 0;
1483 while ( $hebrewMonth <= 12 ) {
1484 # Calculate days in this month
1485 if ( $isLeap && $hebrewMonth == 6 ) {
1486 # Adar in a leap year
1487 if ( $isLeap ) {
1488 # Leap year - has Adar I, with 30 days, and Adar II, with 29 days
1489 $days = 30;
1490 if ( $hebrewDay <= $days ) {
1491 # Day in Adar I
1492 $hebrewMonth = 13;
1493 } else {
1494 # Subtract the days of Adar I
1495 $hebrewDay -= $days;
1496 # Try Adar II
1497 $days = 29;
1498 if ( $hebrewDay <= $days ) {
1499 # Day in Adar II
1500 $hebrewMonth = 14;
1501 }
1502 }
1503 }
1504 } elseif ( $hebrewMonth == 2 && $yearPattern == 2 ) {
1505 # Cheshvan in a complete year (otherwise as the rule below)
1506 $days = 30;
1507 } elseif ( $hebrewMonth == 3 && $yearPattern == 0 ) {
1508 # Kislev in an incomplete year (otherwise as the rule below)
1509 $days = 29;
1510 } else {
1511 # Odd months have 30 days, even have 29
1512 $days = 30 - ( $hebrewMonth - 1 ) % 2;
1513 }
1514 if ( $hebrewDay <= $days ) {
1515 # In the current month
1516 break;
1517 } else {
1518 # Subtract the days of the current month
1519 $hebrewDay -= $days;
1520 # Try in the next month
1521 $hebrewMonth++;
1522 }
1523 }
1524
1525 return array( $hebrewYear, $hebrewMonth, $hebrewDay, $days );
1526 }
1527
1528 /**
1529 * This calculates the Hebrew year start, as days since 1 September.
1530 * Based on Carl Friedrich Gauss algorithm for finding Easter date.
1531 * Used for Hebrew date.
1532 *
1533 * @param $year int
1534 *
1535 * @return string
1536 */
1537 private static function hebrewYearStart( $year ) {
1538 $a = intval( ( 12 * ( $year - 1 ) + 17 ) % 19 );
1539 $b = intval( ( $year - 1 ) % 4 );
1540 $m = 32.044093161144 + 1.5542417966212 * $a + $b / 4.0 - 0.0031777940220923 * ( $year - 1 );
1541 if ( $m < 0 ) {
1542 $m--;
1543 }
1544 $Mar = intval( $m );
1545 if ( $m < 0 ) {
1546 $m++;
1547 }
1548 $m -= $Mar;
1549
1550 $c = intval( ( $Mar + 3 * ( $year - 1 ) + 5 * $b + 5 ) % 7 );
1551 if ( $c == 0 && $a > 11 && $m >= 0.89772376543210 ) {
1552 $Mar++;
1553 } elseif ( $c == 1 && $a > 6 && $m >= 0.63287037037037 ) {
1554 $Mar += 2;
1555 } elseif ( $c == 2 || $c == 4 || $c == 6 ) {
1556 $Mar++;
1557 }
1558
1559 $Mar += intval( ( $year - 3761 ) / 100 ) - intval( ( $year - 3761 ) / 400 ) - 24;
1560 return $Mar;
1561 }
1562
1563 /**
1564 * Algorithm to convert Gregorian dates to Thai solar dates,
1565 * Minguo dates or Minguo dates.
1566 *
1567 * Link: http://en.wikipedia.org/wiki/Thai_solar_calendar
1568 * http://en.wikipedia.org/wiki/Minguo_calendar
1569 * http://en.wikipedia.org/wiki/Japanese_era_name
1570 *
1571 * @param $ts String: 14-character timestamp
1572 * @param $cName String: calender name
1573 * @return Array: converted year, month, day
1574 */
1575 private static function tsToYear( $ts, $cName ) {
1576 $gy = substr( $ts, 0, 4 );
1577 $gm = substr( $ts, 4, 2 );
1578 $gd = substr( $ts, 6, 2 );
1579
1580 if ( !strcmp( $cName, 'thai' ) ) {
1581 # Thai solar dates
1582 # Add 543 years to the Gregorian calendar
1583 # Months and days are identical
1584 $gy_offset = $gy + 543;
1585 } elseif ( ( !strcmp( $cName, 'minguo' ) ) || !strcmp( $cName, 'juche' ) ) {
1586 # Minguo dates
1587 # Deduct 1911 years from the Gregorian calendar
1588 # Months and days are identical
1589 $gy_offset = $gy - 1911;
1590 } elseif ( !strcmp( $cName, 'tenno' ) ) {
1591 # Nengō dates up to Meiji period
1592 # Deduct years from the Gregorian calendar
1593 # depending on the nengo periods
1594 # Months and days are identical
1595 if ( ( $gy < 1912 ) || ( ( $gy == 1912 ) && ( $gm < 7 ) ) || ( ( $gy == 1912 ) && ( $gm == 7 ) && ( $gd < 31 ) ) ) {
1596 # Meiji period
1597 $gy_gannen = $gy - 1868 + 1;
1598 $gy_offset = $gy_gannen;
1599 if ( $gy_gannen == 1 ) {
1600 $gy_offset = '元';
1601 }
1602 $gy_offset = '明治' . $gy_offset;
1603 } elseif (
1604 ( ( $gy == 1912 ) && ( $gm == 7 ) && ( $gd == 31 ) ) ||
1605 ( ( $gy == 1912 ) && ( $gm >= 8 ) ) ||
1606 ( ( $gy > 1912 ) && ( $gy < 1926 ) ) ||
1607 ( ( $gy == 1926 ) && ( $gm < 12 ) ) ||
1608 ( ( $gy == 1926 ) && ( $gm == 12 ) && ( $gd < 26 ) )
1609 )
1610 {
1611 # Taishō period
1612 $gy_gannen = $gy - 1912 + 1;
1613 $gy_offset = $gy_gannen;
1614 if ( $gy_gannen == 1 ) {
1615 $gy_offset = '元';
1616 }
1617 $gy_offset = '大正' . $gy_offset;
1618 } elseif (
1619 ( ( $gy == 1926 ) && ( $gm == 12 ) && ( $gd >= 26 ) ) ||
1620 ( ( $gy > 1926 ) && ( $gy < 1989 ) ) ||
1621 ( ( $gy == 1989 ) && ( $gm == 1 ) && ( $gd < 8 ) )
1622 )
1623 {
1624 # Shōwa period
1625 $gy_gannen = $gy - 1926 + 1;
1626 $gy_offset = $gy_gannen;
1627 if ( $gy_gannen == 1 ) {
1628 $gy_offset = '元';
1629 }
1630 $gy_offset = '昭和' . $gy_offset;
1631 } else {
1632 # Heisei period
1633 $gy_gannen = $gy - 1989 + 1;
1634 $gy_offset = $gy_gannen;
1635 if ( $gy_gannen == 1 ) {
1636 $gy_offset = '元';
1637 }
1638 $gy_offset = '平成' . $gy_offset;
1639 }
1640 } else {
1641 $gy_offset = $gy;
1642 }
1643
1644 return array( $gy_offset, $gm, $gd );
1645 }
1646
1647 /**
1648 * Roman number formatting up to 3000
1649 *
1650 * @param $num int
1651 *
1652 * @return string
1653 */
1654 static function romanNumeral( $num ) {
1655 static $table = array(
1656 array( '', 'I', 'II', 'III', 'IV', 'V', 'VI', 'VII', 'VIII', 'IX', 'X' ),
1657 array( '', 'X', 'XX', 'XXX', 'XL', 'L', 'LX', 'LXX', 'LXXX', 'XC', 'C' ),
1658 array( '', 'C', 'CC', 'CCC', 'CD', 'D', 'DC', 'DCC', 'DCCC', 'CM', 'M' ),
1659 array( '', 'M', 'MM', 'MMM' )
1660 );
1661
1662 $num = intval( $num );
1663 if ( $num > 3000 || $num <= 0 ) {
1664 return $num;
1665 }
1666
1667 $s = '';
1668 for ( $pow10 = 1000, $i = 3; $i >= 0; $pow10 /= 10, $i-- ) {
1669 if ( $num >= $pow10 ) {
1670 $s .= $table[$i][(int)floor( $num / $pow10 )];
1671 }
1672 $num = $num % $pow10;
1673 }
1674 return $s;
1675 }
1676
1677 /**
1678 * Hebrew Gematria number formatting up to 9999
1679 *
1680 * @param $num int
1681 *
1682 * @return string
1683 */
1684 static function hebrewNumeral( $num ) {
1685 static $table = array(
1686 array( '', 'א', 'ב', 'ג', 'ד', 'ה', 'ו', 'ז', 'ח', 'ט', 'י' ),
1687 array( '', 'י', 'כ', 'ל', 'מ', 'נ', 'ס', 'ע', 'פ', 'צ', 'ק' ),
1688 array( '', 'ק', 'ר', 'ש', 'ת', 'תק', 'תר', 'תש', 'תת', 'תתק', 'תתר' ),
1689 array( '', 'א', 'ב', 'ג', 'ד', 'ה', 'ו', 'ז', 'ח', 'ט', 'י' )
1690 );
1691
1692 $num = intval( $num );
1693 if ( $num > 9999 || $num <= 0 ) {
1694 return $num;
1695 }
1696
1697 $s = '';
1698 for ( $pow10 = 1000, $i = 3; $i >= 0; $pow10 /= 10, $i-- ) {
1699 if ( $num >= $pow10 ) {
1700 if ( $num == 15 || $num == 16 ) {
1701 $s .= $table[0][9] . $table[0][$num - 9];
1702 $num = 0;
1703 } else {
1704 $s .= $table[$i][intval( ( $num / $pow10 ) )];
1705 if ( $pow10 == 1000 ) {
1706 $s .= "'";
1707 }
1708 }
1709 }
1710 $num = $num % $pow10;
1711 }
1712 if ( strlen( $s ) == 2 ) {
1713 $str = $s . "'";
1714 } else {
1715 $str = substr( $s, 0, strlen( $s ) - 2 ) . '"';
1716 $str .= substr( $s, strlen( $s ) - 2, 2 );
1717 }
1718 $start = substr( $str, 0, strlen( $str ) - 2 );
1719 $end = substr( $str, strlen( $str ) - 2 );
1720 switch( $end ) {
1721 case 'כ':
1722 $str = $start . 'ך';
1723 break;
1724 case 'מ':
1725 $str = $start . 'ם';
1726 break;
1727 case 'נ':
1728 $str = $start . 'ן';
1729 break;
1730 case 'פ':
1731 $str = $start . 'ף';
1732 break;
1733 case 'צ':
1734 $str = $start . 'ץ';
1735 break;
1736 }
1737 return $str;
1738 }
1739
1740 /**
1741 * Used by date() and time() to adjust the time output.
1742 *
1743 * @param $ts Int the time in date('YmdHis') format
1744 * @param $tz Mixed: adjust the time by this amount (default false, mean we
1745 * get user timecorrection setting)
1746 * @return int
1747 */
1748 function userAdjust( $ts, $tz = false ) {
1749 global $wgUser, $wgLocalTZoffset;
1750
1751 if ( $tz === false ) {
1752 $tz = $wgUser->getOption( 'timecorrection' );
1753 }
1754
1755 $data = explode( '|', $tz, 3 );
1756
1757 if ( $data[0] == 'ZoneInfo' ) {
1758 wfSuppressWarnings();
1759 $userTZ = timezone_open( $data[2] );
1760 wfRestoreWarnings();
1761 if ( $userTZ !== false ) {
1762 $date = date_create( $ts, timezone_open( 'UTC' ) );
1763 date_timezone_set( $date, $userTZ );
1764 $date = date_format( $date, 'YmdHis' );
1765 return $date;
1766 }
1767 # Unrecognized timezone, default to 'Offset' with the stored offset.
1768 $data[0] = 'Offset';
1769 }
1770
1771 $minDiff = 0;
1772 if ( $data[0] == 'System' || $tz == '' ) {
1773 #  Global offset in minutes.
1774 if ( isset( $wgLocalTZoffset ) ) {
1775 $minDiff = $wgLocalTZoffset;
1776 }
1777 } elseif ( $data[0] == 'Offset' ) {
1778 $minDiff = intval( $data[1] );
1779 } else {
1780 $data = explode( ':', $tz );
1781 if ( count( $data ) == 2 ) {
1782 $data[0] = intval( $data[0] );
1783 $data[1] = intval( $data[1] );
1784 $minDiff = abs( $data[0] ) * 60 + $data[1];
1785 if ( $data[0] < 0 ) {
1786 $minDiff = -$minDiff;
1787 }
1788 } else {
1789 $minDiff = intval( $data[0] ) * 60;
1790 }
1791 }
1792
1793 # No difference ? Return time unchanged
1794 if ( 0 == $minDiff ) {
1795 return $ts;
1796 }
1797
1798 wfSuppressWarnings(); // E_STRICT system time bitching
1799 # Generate an adjusted date; take advantage of the fact that mktime
1800 # will normalize out-of-range values so we don't have to split $minDiff
1801 # into hours and minutes.
1802 $t = mktime( (
1803 (int)substr( $ts, 8, 2 ) ), # Hours
1804 (int)substr( $ts, 10, 2 ) + $minDiff, # Minutes
1805 (int)substr( $ts, 12, 2 ), # Seconds
1806 (int)substr( $ts, 4, 2 ), # Month
1807 (int)substr( $ts, 6, 2 ), # Day
1808 (int)substr( $ts, 0, 4 ) ); # Year
1809
1810 $date = date( 'YmdHis', $t );
1811 wfRestoreWarnings();
1812
1813 return $date;
1814 }
1815
1816 /**
1817 * This is meant to be used by time(), date(), and timeanddate() to get
1818 * the date preference they're supposed to use, it should be used in
1819 * all children.
1820 *
1821 *<code>
1822 * function timeanddate([...], $format = true) {
1823 * $datePreference = $this->dateFormat($format);
1824 * [...]
1825 * }
1826 *</code>
1827 *
1828 * @param $usePrefs Mixed: if true, the user's preference is used
1829 * if false, the site/language default is used
1830 * if int/string, assumed to be a format.
1831 * @return string
1832 */
1833 function dateFormat( $usePrefs = true ) {
1834 global $wgUser;
1835
1836 if ( is_bool( $usePrefs ) ) {
1837 if ( $usePrefs ) {
1838 $datePreference = $wgUser->getDatePreference();
1839 } else {
1840 $datePreference = (string)User::getDefaultOption( 'date' );
1841 }
1842 } else {
1843 $datePreference = (string)$usePrefs;
1844 }
1845
1846 // return int
1847 if ( $datePreference == '' ) {
1848 return 'default';
1849 }
1850
1851 return $datePreference;
1852 }
1853
1854 /**
1855 * Get a format string for a given type and preference
1856 * @param $type string May be date, time or both
1857 * @param $pref string The format name as it appears in Messages*.php
1858 *
1859 * @return string
1860 */
1861 function getDateFormatString( $type, $pref ) {
1862 if ( !isset( $this->dateFormatStrings[$type][$pref] ) ) {
1863 if ( $pref == 'default' ) {
1864 $pref = $this->getDefaultDateFormat();
1865 $df = self::$dataCache->getSubitem( $this->mCode, 'dateFormats', "$pref $type" );
1866 } else {
1867 $df = self::$dataCache->getSubitem( $this->mCode, 'dateFormats', "$pref $type" );
1868 if ( is_null( $df ) ) {
1869 $pref = $this->getDefaultDateFormat();
1870 $df = self::$dataCache->getSubitem( $this->mCode, 'dateFormats', "$pref $type" );
1871 }
1872 }
1873 $this->dateFormatStrings[$type][$pref] = $df;
1874 }
1875 return $this->dateFormatStrings[$type][$pref];
1876 }
1877
1878 /**
1879 * @param $ts Mixed: the time format which needs to be turned into a
1880 * date('YmdHis') format with wfTimestamp(TS_MW,$ts)
1881 * @param $adj Bool: whether to adjust the time output according to the
1882 * user configured offset ($timecorrection)
1883 * @param $format Mixed: true to use user's date format preference
1884 * @param $timecorrection String|bool the time offset as returned by
1885 * validateTimeZone() in Special:Preferences
1886 * @return string
1887 */
1888 function date( $ts, $adj = false, $format = true, $timecorrection = false ) {
1889 $ts = wfTimestamp( TS_MW, $ts );
1890 if ( $adj ) {
1891 $ts = $this->userAdjust( $ts, $timecorrection );
1892 }
1893 $df = $this->getDateFormatString( 'date', $this->dateFormat( $format ) );
1894 return $this->sprintfDate( $df, $ts );
1895 }
1896
1897 /**
1898 * @param $ts Mixed: the time format which needs to be turned into a
1899 * date('YmdHis') format with wfTimestamp(TS_MW,$ts)
1900 * @param $adj Bool: whether to adjust the time output according to the
1901 * user configured offset ($timecorrection)
1902 * @param $format Mixed: true to use user's date format preference
1903 * @param $timecorrection String|bool the time offset as returned by
1904 * validateTimeZone() in Special:Preferences
1905 * @return string
1906 */
1907 function time( $ts, $adj = false, $format = true, $timecorrection = false ) {
1908 $ts = wfTimestamp( TS_MW, $ts );
1909 if ( $adj ) {
1910 $ts = $this->userAdjust( $ts, $timecorrection );
1911 }
1912 $df = $this->getDateFormatString( 'time', $this->dateFormat( $format ) );
1913 return $this->sprintfDate( $df, $ts );
1914 }
1915
1916 /**
1917 * @param $ts Mixed: the time format which needs to be turned into a
1918 * date('YmdHis') format with wfTimestamp(TS_MW,$ts)
1919 * @param $adj Bool: whether to adjust the time output according to the
1920 * user configured offset ($timecorrection)
1921 * @param $format Mixed: what format to return, if it's false output the
1922 * default one (default true)
1923 * @param $timecorrection String|bool the time offset as returned by
1924 * validateTimeZone() in Special:Preferences
1925 * @return string
1926 */
1927 function timeanddate( $ts, $adj = false, $format = true, $timecorrection = false ) {
1928 $ts = wfTimestamp( TS_MW, $ts );
1929 if ( $adj ) {
1930 $ts = $this->userAdjust( $ts, $timecorrection );
1931 }
1932 $df = $this->getDateFormatString( 'both', $this->dateFormat( $format ) );
1933 return $this->sprintfDate( $df, $ts );
1934 }
1935
1936 /**
1937 * Takes a number of seconds and turns it into a text using values such as hours and minutes.
1938 *
1939 * @since 1.20
1940 *
1941 * @param integer $seconds The amount of seconds.
1942 * @param array $chosenIntervals The intervals to enable.
1943 *
1944 * @return string
1945 */
1946 public function formatDuration( $seconds, array $chosenIntervals = array() ) {
1947 $intervals = $this->getDurationIntervals( $seconds, $chosenIntervals );
1948
1949 $segments = array();
1950
1951 foreach ( $intervals as $intervalName => $intervalValue ) {
1952 $message = new Message( 'duration-' . $intervalName, array( $intervalValue ) );
1953 $segments[] = $message->inLanguage( $this )->escaped();
1954 }
1955
1956 return $this->listToText( $segments );
1957 }
1958
1959 /**
1960 * Takes a number of seconds and returns an array with a set of corresponding intervals.
1961 * For example 65 will be turned into array( minutes => 1, seconds => 5 ).
1962 *
1963 * @since 1.20
1964 *
1965 * @param integer $seconds The amount of seconds.
1966 * @param array $chosenIntervals The intervals to enable.
1967 *
1968 * @return array
1969 */
1970 public function getDurationIntervals( $seconds, array $chosenIntervals = array() ) {
1971 if ( empty( $chosenIntervals ) ) {
1972 $chosenIntervals = array( 'millennia', 'centuries', 'decades', 'years', 'days', 'hours', 'minutes', 'seconds' );
1973 }
1974
1975 $intervals = array_intersect_key( self::$durationIntervals, array_flip( $chosenIntervals ) );
1976 $sortedNames = array_keys( $intervals );
1977 $smallestInterval = array_pop( $sortedNames );
1978
1979 $segments = array();
1980
1981 foreach ( $intervals as $name => $length ) {
1982 $value = floor( $seconds / $length );
1983
1984 if ( $value > 0 || ( $name == $smallestInterval && empty( $segments ) ) ) {
1985 $seconds -= $value * $length;
1986 $segments[$name] = $value;
1987 }
1988 }
1989
1990 return $segments;
1991 }
1992
1993 /**
1994 * Internal helper function for userDate(), userTime() and userTimeAndDate()
1995 *
1996 * @param $type String: can be 'date', 'time' or 'both'
1997 * @param $ts Mixed: the time format which needs to be turned into a
1998 * date('YmdHis') format with wfTimestamp(TS_MW,$ts)
1999 * @param $user User object used to get preferences for timezone and format
2000 * @param $options Array, can contain the following keys:
2001 * - 'timecorrection': time correction, can have the following values:
2002 * - true: use user's preference
2003 * - false: don't use time correction
2004 * - integer: value of time correction in minutes
2005 * - 'format': format to use, can have the following values:
2006 * - true: use user's preference
2007 * - false: use default preference
2008 * - string: format to use
2009 * @since 1.19
2010 * @return String
2011 */
2012 private function internalUserTimeAndDate( $type, $ts, User $user, array $options ) {
2013 $ts = wfTimestamp( TS_MW, $ts );
2014 $options += array( 'timecorrection' => true, 'format' => true );
2015 if ( $options['timecorrection'] !== false ) {
2016 if ( $options['timecorrection'] === true ) {
2017 $offset = $user->getOption( 'timecorrection' );
2018 } else {
2019 $offset = $options['timecorrection'];
2020 }
2021 $ts = $this->userAdjust( $ts, $offset );
2022 }
2023 if ( $options['format'] === true ) {
2024 $format = $user->getDatePreference();
2025 } else {
2026 $format = $options['format'];
2027 }
2028 $df = $this->getDateFormatString( $type, $this->dateFormat( $format ) );
2029 return $this->sprintfDate( $df, $ts );
2030 }
2031
2032 /**
2033 * Get the formatted date for the given timestamp and formatted for
2034 * the given user.
2035 *
2036 * @param $ts Mixed: the time format which needs to be turned into a
2037 * date('YmdHis') format with wfTimestamp(TS_MW,$ts)
2038 * @param $user User object used to get preferences for timezone and format
2039 * @param $options Array, can contain the following keys:
2040 * - 'timecorrection': time correction, can have the following values:
2041 * - true: use user's preference
2042 * - false: don't use time correction
2043 * - integer: value of time correction in minutes
2044 * - 'format': format to use, can have the following values:
2045 * - true: use user's preference
2046 * - false: use default preference
2047 * - string: format to use
2048 * @since 1.19
2049 * @return String
2050 */
2051 public function userDate( $ts, User $user, array $options = array() ) {
2052 return $this->internalUserTimeAndDate( 'date', $ts, $user, $options );
2053 }
2054
2055 /**
2056 * Get the formatted time for the given timestamp and formatted for
2057 * the given user.
2058 *
2059 * @param $ts Mixed: the time format which needs to be turned into a
2060 * date('YmdHis') format with wfTimestamp(TS_MW,$ts)
2061 * @param $user User object used to get preferences for timezone and format
2062 * @param $options Array, can contain the following keys:
2063 * - 'timecorrection': time correction, can have the following values:
2064 * - true: use user's preference
2065 * - false: don't use time correction
2066 * - integer: value of time correction in minutes
2067 * - 'format': format to use, can have the following values:
2068 * - true: use user's preference
2069 * - false: use default preference
2070 * - string: format to use
2071 * @since 1.19
2072 * @return String
2073 */
2074 public function userTime( $ts, User $user, array $options = array() ) {
2075 return $this->internalUserTimeAndDate( 'time', $ts, $user, $options );
2076 }
2077
2078 /**
2079 * Get the formatted date and time for the given timestamp and formatted for
2080 * the given user.
2081 *
2082 * @param $ts Mixed: the time format which needs to be turned into a
2083 * date('YmdHis') format with wfTimestamp(TS_MW,$ts)
2084 * @param $user User object used to get preferences for timezone and format
2085 * @param $options Array, can contain the following keys:
2086 * - 'timecorrection': time correction, can have the following values:
2087 * - true: use user's preference
2088 * - false: don't use time correction
2089 * - integer: value of time correction in minutes
2090 * - 'format': format to use, can have the following values:
2091 * - true: use user's preference
2092 * - false: use default preference
2093 * - string: format to use
2094 * @since 1.19
2095 * @return String
2096 */
2097 public function userTimeAndDate( $ts, User $user, array $options = array() ) {
2098 return $this->internalUserTimeAndDate( 'both', $ts, $user, $options );
2099 }
2100
2101 /**
2102 * @param $key string
2103 * @return array|null
2104 */
2105 function getMessage( $key ) {
2106 return self::$dataCache->getSubitem( $this->mCode, 'messages', $key );
2107 }
2108
2109 /**
2110 * @return array
2111 */
2112 function getAllMessages() {
2113 return self::$dataCache->getItem( $this->mCode, 'messages' );
2114 }
2115
2116 /**
2117 * @param $in
2118 * @param $out
2119 * @param $string
2120 * @return string
2121 */
2122 function iconv( $in, $out, $string ) {
2123 # This is a wrapper for iconv in all languages except esperanto,
2124 # which does some nasty x-conversions beforehand
2125
2126 # Even with //IGNORE iconv can whine about illegal characters in
2127 # *input* string. We just ignore those too.
2128 # REF: http://bugs.php.net/bug.php?id=37166
2129 # REF: https://bugzilla.wikimedia.org/show_bug.cgi?id=16885
2130 wfSuppressWarnings();
2131 $text = iconv( $in, $out . '//IGNORE', $string );
2132 wfRestoreWarnings();
2133 return $text;
2134 }
2135
2136 // callback functions for uc(), lc(), ucwords(), ucwordbreaks()
2137
2138 /**
2139 * @param $matches array
2140 * @return mixed|string
2141 */
2142 function ucwordbreaksCallbackAscii( $matches ) {
2143 return $this->ucfirst( $matches[1] );
2144 }
2145
2146 /**
2147 * @param $matches array
2148 * @return string
2149 */
2150 function ucwordbreaksCallbackMB( $matches ) {
2151 return mb_strtoupper( $matches[0] );
2152 }
2153
2154 /**
2155 * @param $matches array
2156 * @return string
2157 */
2158 function ucCallback( $matches ) {
2159 list( $wikiUpperChars ) = self::getCaseMaps();
2160 return strtr( $matches[1], $wikiUpperChars );
2161 }
2162
2163 /**
2164 * @param $matches array
2165 * @return string
2166 */
2167 function lcCallback( $matches ) {
2168 list( , $wikiLowerChars ) = self::getCaseMaps();
2169 return strtr( $matches[1], $wikiLowerChars );
2170 }
2171
2172 /**
2173 * @param $matches array
2174 * @return string
2175 */
2176 function ucwordsCallbackMB( $matches ) {
2177 return mb_strtoupper( $matches[0] );
2178 }
2179
2180 /**
2181 * @param $matches array
2182 * @return string
2183 */
2184 function ucwordsCallbackWiki( $matches ) {
2185 list( $wikiUpperChars ) = self::getCaseMaps();
2186 return strtr( $matches[0], $wikiUpperChars );
2187 }
2188
2189 /**
2190 * Make a string's first character uppercase
2191 *
2192 * @param $str string
2193 *
2194 * @return string
2195 */
2196 function ucfirst( $str ) {
2197 $o = ord( $str );
2198 if ( $o < 96 ) { // if already uppercase...
2199 return $str;
2200 } elseif ( $o < 128 ) {
2201 return ucfirst( $str ); // use PHP's ucfirst()
2202 } else {
2203 // fall back to more complex logic in case of multibyte strings
2204 return $this->uc( $str, true );
2205 }
2206 }
2207
2208 /**
2209 * Convert a string to uppercase
2210 *
2211 * @param $str string
2212 * @param $first bool
2213 *
2214 * @return string
2215 */
2216 function uc( $str, $first = false ) {
2217 if ( function_exists( 'mb_strtoupper' ) ) {
2218 if ( $first ) {
2219 if ( $this->isMultibyte( $str ) ) {
2220 return mb_strtoupper( mb_substr( $str, 0, 1 ) ) . mb_substr( $str, 1 );
2221 } else {
2222 return ucfirst( $str );
2223 }
2224 } else {
2225 return $this->isMultibyte( $str ) ? mb_strtoupper( $str ) : strtoupper( $str );
2226 }
2227 } else {
2228 if ( $this->isMultibyte( $str ) ) {
2229 $x = $first ? '^' : '';
2230 return preg_replace_callback(
2231 "/$x([a-z]|[\\xc0-\\xff][\\x80-\\xbf]*)/",
2232 array( $this, 'ucCallback' ),
2233 $str
2234 );
2235 } else {
2236 return $first ? ucfirst( $str ) : strtoupper( $str );
2237 }
2238 }
2239 }
2240
2241 /**
2242 * @param $str string
2243 * @return mixed|string
2244 */
2245 function lcfirst( $str ) {
2246 $o = ord( $str );
2247 if ( !$o ) {
2248 return strval( $str );
2249 } elseif ( $o >= 128 ) {
2250 return $this->lc( $str, true );
2251 } elseif ( $o > 96 ) {
2252 return $str;
2253 } else {
2254 $str[0] = strtolower( $str[0] );
2255 return $str;
2256 }
2257 }
2258
2259 /**
2260 * @param $str string
2261 * @param $first bool
2262 * @return mixed|string
2263 */
2264 function lc( $str, $first = false ) {
2265 if ( function_exists( 'mb_strtolower' ) ) {
2266 if ( $first ) {
2267 if ( $this->isMultibyte( $str ) ) {
2268 return mb_strtolower( mb_substr( $str, 0, 1 ) ) . mb_substr( $str, 1 );
2269 } else {
2270 return strtolower( substr( $str, 0, 1 ) ) . substr( $str, 1 );
2271 }
2272 } else {
2273 return $this->isMultibyte( $str ) ? mb_strtolower( $str ) : strtolower( $str );
2274 }
2275 } else {
2276 if ( $this->isMultibyte( $str ) ) {
2277 $x = $first ? '^' : '';
2278 return preg_replace_callback(
2279 "/$x([A-Z]|[\\xc0-\\xff][\\x80-\\xbf]*)/",
2280 array( $this, 'lcCallback' ),
2281 $str
2282 );
2283 } else {
2284 return $first ? strtolower( substr( $str, 0, 1 ) ) . substr( $str, 1 ) : strtolower( $str );
2285 }
2286 }
2287 }
2288
2289 /**
2290 * @param $str string
2291 * @return bool
2292 */
2293 function isMultibyte( $str ) {
2294 return (bool)preg_match( '/[\x80-\xff]/', $str );
2295 }
2296
2297 /**
2298 * @param $str string
2299 * @return mixed|string
2300 */
2301 function ucwords( $str ) {
2302 if ( $this->isMultibyte( $str ) ) {
2303 $str = $this->lc( $str );
2304
2305 // regexp to find first letter in each word (i.e. after each space)
2306 $replaceRegexp = "/^([a-z]|[\\xc0-\\xff][\\x80-\\xbf]*)| ([a-z]|[\\xc0-\\xff][\\x80-\\xbf]*)/";
2307
2308 // function to use to capitalize a single char
2309 if ( function_exists( 'mb_strtoupper' ) ) {
2310 return preg_replace_callback(
2311 $replaceRegexp,
2312 array( $this, 'ucwordsCallbackMB' ),
2313 $str
2314 );
2315 } else {
2316 return preg_replace_callback(
2317 $replaceRegexp,
2318 array( $this, 'ucwordsCallbackWiki' ),
2319 $str
2320 );
2321 }
2322 } else {
2323 return ucwords( strtolower( $str ) );
2324 }
2325 }
2326
2327 /**
2328 * capitalize words at word breaks
2329 *
2330 * @param $str string
2331 * @return mixed
2332 */
2333 function ucwordbreaks( $str ) {
2334 if ( $this->isMultibyte( $str ) ) {
2335 $str = $this->lc( $str );
2336
2337 // since \b doesn't work for UTF-8, we explicitely define word break chars
2338 $breaks = "[ \-\(\)\}\{\.,\?!]";
2339
2340 // find first letter after word break
2341 $replaceRegexp = "/^([a-z]|[\\xc0-\\xff][\\x80-\\xbf]*)|$breaks([a-z]|[\\xc0-\\xff][\\x80-\\xbf]*)/";
2342
2343 if ( function_exists( 'mb_strtoupper' ) ) {
2344 return preg_replace_callback(
2345 $replaceRegexp,
2346 array( $this, 'ucwordbreaksCallbackMB' ),
2347 $str
2348 );
2349 } else {
2350 return preg_replace_callback(
2351 $replaceRegexp,
2352 array( $this, 'ucwordsCallbackWiki' ),
2353 $str
2354 );
2355 }
2356 } else {
2357 return preg_replace_callback(
2358 '/\b([\w\x80-\xff]+)\b/',
2359 array( $this, 'ucwordbreaksCallbackAscii' ),
2360 $str
2361 );
2362 }
2363 }
2364
2365 /**
2366 * Return a case-folded representation of $s
2367 *
2368 * This is a representation such that caseFold($s1)==caseFold($s2) if $s1
2369 * and $s2 are the same except for the case of their characters. It is not
2370 * necessary for the value returned to make sense when displayed.
2371 *
2372 * Do *not* perform any other normalisation in this function. If a caller
2373 * uses this function when it should be using a more general normalisation
2374 * function, then fix the caller.
2375 *
2376 * @param $s string
2377 *
2378 * @return string
2379 */
2380 function caseFold( $s ) {
2381 return $this->uc( $s );
2382 }
2383
2384 /**
2385 * @param $s string
2386 * @return string
2387 */
2388 function checkTitleEncoding( $s ) {
2389 if ( is_array( $s ) ) {
2390 wfDebugDieBacktrace( 'Given array to checkTitleEncoding.' );
2391 }
2392 # Check for non-UTF-8 URLs
2393 $ishigh = preg_match( '/[\x80-\xff]/', $s );
2394 if ( !$ishigh ) {
2395 return $s;
2396 }
2397
2398 $isutf8 = preg_match( '/^([\x00-\x7f]|[\xc0-\xdf][\x80-\xbf]|' .
2399 '[\xe0-\xef][\x80-\xbf]{2}|[\xf0-\xf7][\x80-\xbf]{3})+$/', $s );
2400 if ( $isutf8 ) {
2401 return $s;
2402 }
2403
2404 return $this->iconv( $this->fallback8bitEncoding(), 'utf-8', $s );
2405 }
2406
2407 /**
2408 * @return array
2409 */
2410 function fallback8bitEncoding() {
2411 return self::$dataCache->getItem( $this->mCode, 'fallback8bitEncoding' );
2412 }
2413
2414 /**
2415 * Most writing systems use whitespace to break up words.
2416 * Some languages such as Chinese don't conventionally do this,
2417 * which requires special handling when breaking up words for
2418 * searching etc.
2419 *
2420 * @return bool
2421 */
2422 function hasWordBreaks() {
2423 return true;
2424 }
2425
2426 /**
2427 * Some languages such as Chinese require word segmentation,
2428 * Specify such segmentation when overridden in derived class.
2429 *
2430 * @param $string String
2431 * @return String
2432 */
2433 function segmentByWord( $string ) {
2434 return $string;
2435 }
2436
2437 /**
2438 * Some languages have special punctuation need to be normalized.
2439 * Make such changes here.
2440 *
2441 * @param $string String
2442 * @return String
2443 */
2444 function normalizeForSearch( $string ) {
2445 return self::convertDoubleWidth( $string );
2446 }
2447
2448 /**
2449 * convert double-width roman characters to single-width.
2450 * range: ff00-ff5f ~= 0020-007f
2451 *
2452 * @param $string string
2453 *
2454 * @return string
2455 */
2456 protected static function convertDoubleWidth( $string ) {
2457 static $full = null;
2458 static $half = null;
2459
2460 if ( $full === null ) {
2461 $fullWidth = "０１２３４５６７８９ＡＢＣＤＥＦＧＨＩＪＫＬＭＮＯＰＱＲＳＴＵＶＷＸＹＺａｂｃｄｅｆｇｈｉｊｋｌｍｎｏｐｑｒｓｔｕｖｗｘｙｚ";
2462 $halfWidth = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
2463 $full = str_split( $fullWidth, 3 );
2464 $half = str_split( $halfWidth );
2465 }
2466
2467 $string = str_replace( $full, $half, $string );
2468 return $string;
2469 }
2470
2471 /**
2472 * @param $string string
2473 * @param $pattern string
2474 * @return string
2475 */
2476 protected static function insertSpace( $string, $pattern ) {
2477 $string = preg_replace( $pattern, " $1 ", $string );
2478 $string = preg_replace( '/ +/', ' ', $string );
2479 return $string;
2480 }
2481
2482 /**
2483 * @param $termsArray array
2484 * @return array
2485 */
2486 function convertForSearchResult( $termsArray ) {
2487 # some languages, e.g. Chinese, need to do a conversion
2488 # in order for search results to be displayed correctly
2489 return $termsArray;
2490 }
2491
2492 /**
2493 * Get the first character of a string.
2494 *
2495 * @param $s string
2496 * @return string
2497 */
2498 function firstChar( $s ) {
2499 $matches = array();
2500 preg_match(
2501 '/^([\x00-\x7f]|[\xc0-\xdf][\x80-\xbf]|' .
2502 '[\xe0-\xef][\x80-\xbf]{2}|[\xf0-\xf7][\x80-\xbf]{3})/',
2503 $s,
2504 $matches
2505 );
2506
2507 if ( isset( $matches[1] ) ) {
2508 if ( strlen( $matches[1] ) != 3 ) {
2509 return $matches[1];
2510 }
2511
2512 // Break down Hangul syllables to grab the first jamo
2513 $code = utf8ToCodepoint( $matches[1] );
2514 if ( $code < 0xac00 || 0xd7a4 <= $code ) {
2515 return $matches[1];
2516 } elseif ( $code < 0xb098 ) {
2517 return "\xe3\x84\xb1";
2518 } elseif ( $code < 0xb2e4 ) {
2519 return "\xe3\x84\xb4";
2520 } elseif ( $code < 0xb77c ) {
2521 return "\xe3\x84\xb7";
2522 } elseif ( $code < 0xb9c8 ) {
2523 return "\xe3\x84\xb9";
2524 } elseif ( $code < 0xbc14 ) {
2525 return "\xe3\x85\x81";
2526 } elseif ( $code < 0xc0ac ) {
2527 return "\xe3\x85\x82";
2528 } elseif ( $code < 0xc544 ) {
2529 return "\xe3\x85\x85";
2530 } elseif ( $code < 0xc790 ) {
2531 return "\xe3\x85\x87";
2532 } elseif ( $code < 0xcc28 ) {
2533 return "\xe3\x85\x88";
2534 } elseif ( $code < 0xce74 ) {
2535 return "\xe3\x85\x8a";
2536 } elseif ( $code < 0xd0c0 ) {
2537 return "\xe3\x85\x8b";
2538 } elseif ( $code < 0xd30c ) {
2539 return "\xe3\x85\x8c";
2540 } elseif ( $code < 0xd558 ) {
2541 return "\xe3\x85\x8d";
2542 } else {
2543 return "\xe3\x85\x8e";
2544 }
2545 } else {
2546 return '';
2547 }
2548 }
2549
2550 function initEncoding() {
2551 # Some languages may have an alternate char encoding option
2552 # (Esperanto X-coding, Japanese furigana conversion, etc)
2553 # If this language is used as the primary content language,
2554 # an override to the defaults can be set here on startup.
2555 }
2556
2557 /**
2558 * @param $s string
2559 * @return string
2560 */
2561 function recodeForEdit( $s ) {
2562 # For some languages we'll want to explicitly specify
2563 # which characters make it into the edit box raw
2564 # or are converted in some way or another.
2565 global $wgEditEncoding;
2566 if ( $wgEditEncoding == '' || $wgEditEncoding == 'UTF-8' ) {
2567 return $s;
2568 } else {
2569 return $this->iconv( 'UTF-8', $wgEditEncoding, $s );
2570 }
2571 }
2572
2573 /**
2574 * @param $s string
2575 * @return string
2576 */
2577 function recodeInput( $s ) {
2578 # Take the previous into account.
2579 global $wgEditEncoding;
2580 if ( $wgEditEncoding != '' ) {
2581 $enc = $wgEditEncoding;
2582 } else {
2583 $enc = 'UTF-8';
2584 }
2585 if ( $enc == 'UTF-8' ) {
2586 return $s;
2587 } else {
2588 return $this->iconv( $enc, 'UTF-8', $s );
2589 }
2590 }
2591
2592 /**
2593 * Convert a UTF-8 string to normal form C. In Malayalam and Arabic, this
2594 * also cleans up certain backwards-compatible sequences, converting them
2595 * to the modern Unicode equivalent.
2596 *
2597 * This is language-specific for performance reasons only.
2598 *
2599 * @param $s string
2600 *
2601 * @return string
2602 */
2603 function normalize( $s ) {
2604 global $wgAllUnicodeFixes;
2605 $s = UtfNormal::cleanUp( $s );
2606 if ( $wgAllUnicodeFixes ) {
2607 $s = $this->transformUsingPairFile( 'normalize-ar.ser', $s );
2608 $s = $this->transformUsingPairFile( 'normalize-ml.ser', $s );
2609 }
2610
2611 return $s;
2612 }
2613
2614 /**
2615 * Transform a string using serialized data stored in the given file (which
2616 * must be in the serialized subdirectory of $IP). The file contains pairs
2617 * mapping source characters to destination characters.
2618 *
2619 * The data is cached in process memory. This will go faster if you have the
2620 * FastStringSearch extension.
2621 *
2622 * @param $file string
2623 * @param $string string
2624 *
2625 * @throws MWException
2626 * @return string
2627 */
2628 function transformUsingPairFile( $file, $string ) {
2629 if ( !isset( $this->transformData[$file] ) ) {
2630 $data = wfGetPrecompiledData( $file );
2631 if ( $data === false ) {
2632 throw new MWException( __METHOD__ . ": The transformation file $file is missing" );
2633 }
2634 $this->transformData[$file] = new ReplacementArray( $data );
2635 }
2636 return $this->transformData[$file]->replace( $string );
2637 }
2638
2639 /**
2640 * For right-to-left language support
2641 *
2642 * @return bool
2643 */
2644 function isRTL() {
2645 return self::$dataCache->getItem( $this->mCode, 'rtl' );
2646 }
2647
2648 /**
2649 * Return the correct HTML 'dir' attribute value for this language.
2650 * @return String
2651 */
2652 function getDir() {
2653 return $this->isRTL() ? 'rtl' : 'ltr';
2654 }
2655
2656 /**
2657 * Return 'left' or 'right' as appropriate alignment for line-start
2658 * for this language's text direction.
2659 *
2660 * Should be equivalent to CSS3 'start' text-align value....
2661 *
2662 * @return String
2663 */
2664 function alignStart() {
2665 return $this->isRTL() ? 'right' : 'left';
2666 }
2667
2668 /**
2669 * Return 'right' or 'left' as appropriate alignment for line-end
2670 * for this language's text direction.
2671 *
2672 * Should be equivalent to CSS3 'end' text-align value....
2673 *
2674 * @return String
2675 */
2676 function alignEnd() {
2677 return $this->isRTL() ? 'left' : 'right';
2678 }
2679
2680 /**
2681 * A hidden direction mark (LRM or RLM), depending on the language direction.
2682 * Unlike getDirMark(), this function returns the character as an HTML entity.
2683 * This function should be used when the output is guaranteed to be HTML,
2684 * because it makes the output HTML source code more readable. When
2685 * the output is plain text or can be escaped, getDirMark() should be used.
2686 *
2687 * @param $opposite Boolean Get the direction mark opposite to your language
2688 * @return string
2689 */
2690 function getDirMarkEntity( $opposite = false ) {
2691 if ( $opposite ) { return $this->isRTL() ? '&lrm;' : '&rlm;'; }
2692 return $this->isRTL() ? '&rlm;' : '&lrm;';
2693 }
2694
2695 /**
2696 * A hidden direction mark (LRM or RLM), depending on the language direction.
2697 * This function produces them as invisible Unicode characters and
2698 * the output may be hard to read and debug, so it should only be used
2699 * when the output is plain text or can be escaped. When the output is
2700 * HTML, use getDirMarkEntity() instead.
2701 *
2702 * @param $opposite Boolean Get the direction mark opposite to your language
2703 * @return string
2704 */
2705 function getDirMark( $opposite = false ) {
2706 $lrm = "\xE2\x80\x8E"; # LEFT-TO-RIGHT MARK, commonly abbreviated LRM
2707 $rlm = "\xE2\x80\x8F"; # RIGHT-TO-LEFT MARK, commonly abbreviated RLM
2708 if ( $opposite ) { return $this->isRTL() ? $lrm : $rlm; }
2709 return $this->isRTL() ? $rlm : $lrm;
2710 }
2711
2712 /**
2713 * @return array
2714 */
2715 function capitalizeAllNouns() {
2716 return self::$dataCache->getItem( $this->mCode, 'capitalizeAllNouns' );
2717 }
2718
2719 /**
2720 * An arrow, depending on the language direction.
2721 *
2722 * @param $direction String: the direction of the arrow: forwards (default), backwards, left, right, up, down.
2723 * @return string
2724 */
2725 function getArrow( $direction = 'forwards' ) {
2726 switch ( $direction ) {
2727 case 'forwards':
2728 return $this->isRTL() ? '←' : '→';
2729 case 'backwards':
2730 return $this->isRTL() ? '→' : '←';
2731 case 'left':
2732 return '←';
2733 case 'right':
2734 return '→';
2735 case 'up':
2736 return '↑';
2737 case 'down':
2738 return '↓';
2739 }
2740 }
2741
2742 /**
2743 * To allow "foo[[bar]]" to extend the link over the whole word "foobar"
2744 *
2745 * @return bool
2746 */
2747 function linkPrefixExtension() {
2748 return self::$dataCache->getItem( $this->mCode, 'linkPrefixExtension' );
2749 }
2750
2751 /**
2752 * @return array
2753 */
2754 function getMagicWords() {
2755 return self::$dataCache->getItem( $this->mCode, 'magicWords' );
2756 }
2757
2758 protected function doMagicHook() {
2759 if ( $this->mMagicHookDone ) {
2760 return;
2761 }
2762 $this->mMagicHookDone = true;
2763 wfProfileIn( 'LanguageGetMagic' );
2764 wfRunHooks( 'LanguageGetMagic', array( &$this->mMagicExtensions, $this->getCode() ) );
2765 wfProfileOut( 'LanguageGetMagic' );
2766 }
2767
2768 /**
2769 * Fill a MagicWord object with data from here
2770 *
2771 * @param $mw
2772 */
2773 function getMagic( $mw ) {
2774 $this->doMagicHook();
2775
2776 if ( isset( $this->mMagicExtensions[$mw->mId] ) ) {
2777 $rawEntry = $this->mMagicExtensions[$mw->mId];
2778 } else {
2779 $magicWords = $this->getMagicWords();
2780 if ( isset( $magicWords[$mw->mId] ) ) {
2781 $rawEntry = $magicWords[$mw->mId];
2782 } else {
2783 $rawEntry = false;
2784 }
2785 }
2786
2787 if ( !is_array( $rawEntry ) ) {
2788 error_log( "\"$rawEntry\" is not a valid magic word for \"$mw->mId\"" );
2789 } else {
2790 $mw->mCaseSensitive = $rawEntry[0];
2791 $mw->mSynonyms = array_slice( $rawEntry, 1 );
2792 }
2793 }
2794
2795 /**
2796 * Add magic words to the extension array
2797 *
2798 * @param $newWords array
2799 */
2800 function addMagicWordsByLang( $newWords ) {
2801 $fallbackChain = $this->getFallbackLanguages();
2802 $fallbackChain = array_reverse( $fallbackChain );
2803 foreach ( $fallbackChain as $code ) {
2804 if ( isset( $newWords[$code] ) ) {
2805 $this->mMagicExtensions = $newWords[$code] + $this->mMagicExtensions;
2806 }
2807 }
2808 }
2809
2810 /**
2811 * Get special page names, as an associative array
2812 * case folded alias => real name
2813 */
2814 function getSpecialPageAliases() {
2815 // Cache aliases because it may be slow to load them
2816 if ( is_null( $this->mExtendedSpecialPageAliases ) ) {
2817 // Initialise array
2818 $this->mExtendedSpecialPageAliases =
2819 self::$dataCache->getItem( $this->mCode, 'specialPageAliases' );
2820 wfRunHooks( 'LanguageGetSpecialPageAliases',
2821 array( &$this->mExtendedSpecialPageAliases, $this->getCode() ) );
2822 }
2823
2824 return $this->mExtendedSpecialPageAliases;
2825 }
2826
2827 /**
2828 * Italic is unsuitable for some languages
2829 *
2830 * @param $text String: the text to be emphasized.
2831 * @return string
2832 */
2833 function emphasize( $text ) {
2834 return "<em>$text</em>";
2835 }
2836
2837 /**
2838 * Normally we output all numbers in plain en_US style, that is
2839 * 293,291.235 for twohundredninetythreethousand-twohundredninetyone
2840 * point twohundredthirtyfive. However this is not suitable for all
2841 * languages, some such as Pakaran want ੨੯੩,੨੯੫.੨੩੫ and others such as
2842 * Icelandic just want to use commas instead of dots, and dots instead
2843 * of commas like "293.291,235".
2844 *
2845 * An example of this function being called:
2846 * <code>
2847 * wfMsg( 'message', $wgLang->formatNum( $num ) )
2848 * </code>
2849 *
2850 * See LanguageGu.php for the Gujarati implementation and
2851 * $separatorTransformTable on MessageIs.php for
2852 * the , => . and . => , implementation.
2853 *
2854 * @todo check if it's viable to use localeconv() for the decimal
2855 * separator thing.
2856 * @param $number Mixed: the string to be formatted, should be an integer
2857 * or a floating point number.
2858 * @param $nocommafy Bool: set to true for special numbers like dates
2859 * @return string
2860 */
2861 public function formatNum( $number, $nocommafy = false ) {
2862 global $wgTranslateNumerals;
2863 if ( !$nocommafy ) {
2864 $number = $this->commafy( $number );
2865 $s = $this->separatorTransformTable();
2866 if ( $s ) {
2867 $number = strtr( $number, $s );
2868 }
2869 }
2870
2871 if ( $wgTranslateNumerals ) {
2872 $s = $this->digitTransformTable();
2873 if ( $s ) {
2874 $number = strtr( $number, $s );
2875 }
2876 }
2877
2878 return $number;
2879 }
2880
2881 /**
2882 * @param $number string
2883 * @return string
2884 */
2885 function parseFormattedNumber( $number ) {
2886 $s = $this->digitTransformTable();
2887 if ( $s ) {
2888 $number = strtr( $number, array_flip( $s ) );
2889 }
2890
2891 $s = $this->separatorTransformTable();
2892 if ( $s ) {
2893 $number = strtr( $number, array_flip( $s ) );
2894 }
2895
2896 $number = strtr( $number, array( ',' => '' ) );
2897 return $number;
2898 }
2899
2900 /**
2901 * Adds commas to a given number
2902 * @since 1.19
2903 * @param $_ mixed
2904 * @return string
2905 */
2906 function commafy( $_ ) {
2907 $digitGroupingPattern = $this->digitGroupingPattern();
2908 if ( $_ === null ) {
2909 return '';
2910 }
2911
2912 if ( !$digitGroupingPattern || $digitGroupingPattern === "###,###,###" ) {
2913 // default grouping is at thousands, use the same for ###,###,### pattern too.
2914 return strrev( (string)preg_replace( '/(\d{3})(?=\d)(?!\d*\.)/', '$1,', strrev( $_ ) ) );
2915 } else {
2916 // Ref: http://cldr.unicode.org/translation/number-patterns
2917 $sign = "";
2918 if ( intval( $_ ) < 0 ) {
2919 // For negative numbers apply the algorithm like positive number and add sign.
2920 $sign = "-";
2921 $_ = substr( $_, 1 );
2922 }
2923 $numberpart = array();
2924 $decimalpart = array();
2925 $numMatches = preg_match_all( "/(#+)/", $digitGroupingPattern, $matches );
2926 preg_match( "/\d+/", $_, $numberpart );
2927 preg_match( "/\.\d*/", $_, $decimalpart );
2928 $groupedNumber = ( count( $decimalpart ) > 0 ) ? $decimalpart[0]:"";
2929 if ( $groupedNumber === $_ ) {
2930 // the string does not have any number part. Eg: .12345
2931 return $sign . $groupedNumber;
2932 }
2933 $start = $end = strlen( $numberpart[0] );
2934 while ( $start > 0 ) {
2935 $match = $matches[0][$numMatches -1] ;
2936 $matchLen = strlen( $match );
2937 $start = $end - $matchLen;
2938 if ( $start < 0 ) {
2939 $start = 0;
2940 }
2941 $groupedNumber = substr( $_ , $start, $end -$start ) . $groupedNumber ;
2942 $end = $start;
2943 if ( $numMatches > 1 ) {
2944 // use the last pattern for the rest of the number
2945 $numMatches--;
2946 }
2947 if ( $start > 0 ) {
2948 $groupedNumber = "," . $groupedNumber;
2949 }
2950 }
2951 return $sign . $groupedNumber;
2952 }
2953 }
2954 /**
2955 * @return String
2956 */
2957 function digitGroupingPattern() {
2958 return self::$dataCache->getItem( $this->mCode, 'digitGroupingPattern' );
2959 }
2960
2961 /**
2962 * @return array
2963 */
2964 function digitTransformTable() {
2965 return self::$dataCache->getItem( $this->mCode, 'digitTransformTable' );
2966 }
2967
2968 /**
2969 * @return array
2970 */
2971 function separatorTransformTable() {
2972 return self::$dataCache->getItem( $this->mCode, 'separatorTransformTable' );
2973 }
2974
2975 /**
2976 * Take a list of strings and build a locale-friendly comma-separated
2977 * list, using the local comma-separator message.
2978 * The last two strings are chained with an "and".
2979 *
2980 * @param $l Array
2981 * @return string
2982 */
2983 function listToText( array $l ) {
2984 $s = '';
2985 $m = count( $l ) - 1;
2986 if ( $m == 1 ) {
2987 return $l[0] . $this->getMessageFromDB( 'and' ) . $this->getMessageFromDB( 'word-separator' ) . $l[1];
2988 } else {
2989 for ( $i = $m; $i >= 0; $i-- ) {
2990 if ( $i == $m ) {
2991 $s = $l[$i];
2992 } elseif ( $i == $m - 1 ) {
2993 $s = $l[$i] . $this->getMessageFromDB( 'and' ) . $this->getMessageFromDB( 'word-separator' ) . $s;
2994 } else {
2995 $s = $l[$i] . $this->getMessageFromDB( 'comma-separator' ) . $s;
2996 }
2997 }
2998 return $s;
2999 }
3000 }
3001
3002 /**
3003 * Take a list of strings and build a locale-friendly comma-separated
3004 * list, using the local comma-separator message.
3005 * @param $list array of strings to put in a comma list
3006 * @return string
3007 */
3008 function commaList( array $list ) {
3009 return implode(
3010 wfMsgExt(
3011 'comma-separator',
3012 array( 'parsemag', 'escapenoentities', 'language' => $this )
3013 ),
3014 $list
3015 );
3016 }
3017
3018 /**
3019 * Take a list of strings and build a locale-friendly semicolon-separated
3020 * list, using the local semicolon-separator message.
3021 * @param $list array of strings to put in a semicolon list
3022 * @return string
3023 */
3024 function semicolonList( array $list ) {
3025 return implode(
3026 wfMsgExt(
3027 'semicolon-separator',
3028 array( 'parsemag', 'escapenoentities', 'language' => $this )
3029 ),
3030 $list
3031 );
3032 }
3033
3034 /**
3035 * Same as commaList, but separate it with the pipe instead.
3036 * @param $list array of strings to put in a pipe list
3037 * @return string
3038 */
3039 function pipeList( array $list ) {
3040 return implode(
3041 wfMsgExt(
3042 'pipe-separator',
3043 array( 'escapenoentities', 'language' => $this )
3044 ),
3045 $list
3046 );
3047 }
3048
3049 /**
3050 * Truncate a string to a specified length in bytes, appending an optional
3051 * string (e.g. for ellipses)
3052 *
3053 * The database offers limited byte lengths for some columns in the database;
3054 * multi-byte character sets mean we need to ensure that only whole characters
3055 * are included, otherwise broken characters can be passed to the user
3056 *
3057 * If $length is negative, the string will be truncated from the beginning
3058 *
3059 * @param $string String to truncate
3060 * @param $length Int: maximum length (including ellipses)
3061 * @param $ellipsis String to append to the truncated text
3062 * @param $adjustLength Boolean: Subtract length of ellipsis from $length.
3063 * $adjustLength was introduced in 1.18, before that behaved as if false.
3064 * @return string
3065 */
3066 function truncate( $string, $length, $ellipsis = '...', $adjustLength = true ) {
3067 # Use the localized ellipsis character
3068 if ( $ellipsis == '...' ) {
3069 $ellipsis = wfMsgExt( 'ellipsis', array( 'escapenoentities', 'language' => $this ) );
3070 }
3071 # Check if there is no need to truncate
3072 if ( $length == 0 ) {
3073 return $ellipsis; // convention
3074 } elseif ( strlen( $string ) <= abs( $length ) ) {
3075 return $string; // no need to truncate
3076 }
3077 $stringOriginal = $string;
3078 # If ellipsis length is >= $length then we can't apply $adjustLength
3079 if ( $adjustLength && strlen( $ellipsis ) >= abs( $length ) ) {
3080 $string = $ellipsis; // this can be slightly unexpected
3081 # Otherwise, truncate and add ellipsis...
3082 } else {
3083 $eLength = $adjustLength ? strlen( $ellipsis ) : 0;
3084 if ( $length > 0 ) {
3085 $length -= $eLength;
3086 $string = substr( $string, 0, $length ); // xyz...
3087 $string = $this->removeBadCharLast( $string );
3088 $string = $string . $ellipsis;
3089 } else {
3090 $length += $eLength;
3091 $string = substr( $string, $length ); // ...xyz
3092 $string = $this->removeBadCharFirst( $string );
3093 $string = $ellipsis . $string;
3094 }
3095 }
3096 # Do not truncate if the ellipsis makes the string longer/equal (bug 22181).
3097 # This check is *not* redundant if $adjustLength, due to the single case where
3098 # LEN($ellipsis) > ABS($limit arg); $stringOriginal could be shorter than $string.
3099 if ( strlen( $string ) < strlen( $stringOriginal ) ) {
3100 return $string;
3101 } else {
3102 return $stringOriginal;
3103 }
3104 }
3105
3106 /**
3107 * Remove bytes that represent an incomplete Unicode character
3108 * at the end of string (e.g. bytes of the char are missing)
3109 *
3110 * @param $string String
3111 * @return string
3112 */
3113 protected function removeBadCharLast( $string ) {
3114 if ( $string != '' ) {
3115 $char = ord( $string[strlen( $string ) - 1] );
3116 $m = array();
3117 if ( $char >= 0xc0 ) {
3118 # We got the first byte only of a multibyte char; remove it.
3119 $string = substr( $string, 0, -1 );
3120 } elseif ( $char >= 0x80 &&
3121 preg_match( '/^(.*)(?:[\xe0-\xef][\x80-\xbf]|' .
3122 '[\xf0-\xf7][\x80-\xbf]{1,2})$/', $string, $m ) )
3123 {
3124 # We chopped in the middle of a character; remove it
3125 $string = $m[1];
3126 }
3127 }
3128 return $string;
3129 }
3130
3131 /**
3132 * Remove bytes that represent an incomplete Unicode character
3133 * at the start of string (e.g. bytes of the char are missing)
3134 *
3135 * @param $string String
3136 * @return string
3137 */
3138 protected function removeBadCharFirst( $string ) {
3139 if ( $string != '' ) {
3140 $char = ord( $string[0] );
3141 if ( $char >= 0x80 && $char < 0xc0 ) {
3142 # We chopped in the middle of a character; remove the whole thing
3143 $string = preg_replace( '/^[\x80-\xbf]+/', '', $string );
3144 }
3145 }
3146 return $string;
3147 }
3148
3149 /**
3150 * Truncate a string of valid HTML to a specified length in bytes,
3151 * appending an optional string (e.g. for ellipses), and return valid HTML
3152 *
3153 * This is only intended for styled/linked text, such as HTML with
3154 * tags like <span> and <a>, were the tags are self-contained (valid HTML).
3155 * Also, this will not detect things like "display:none" CSS.
3156 *
3157 * Note: since 1.18 you do not need to leave extra room in $length for ellipses.
3158 *
3159 * @param string $text HTML string to truncate
3160 * @param int $length (zero/positive) Maximum length (including ellipses)
3161 * @param string $ellipsis String to append to the truncated text
3162 * @return string
3163 */
3164 function truncateHtml( $text, $length, $ellipsis = '...' ) {
3165 # Use the localized ellipsis character
3166 if ( $ellipsis == '...' ) {
3167 $ellipsis = wfMsgExt( 'ellipsis', array( 'escapenoentities', 'language' => $this ) );
3168 }
3169 # Check if there is clearly no need to truncate
3170 if ( $length <= 0 ) {
3171 return $ellipsis; // no text shown, nothing to format (convention)
3172 } elseif ( strlen( $text ) <= $length ) {
3173 return $text; // string short enough even *with* HTML (short-circuit)
3174 }
3175
3176 $dispLen = 0; // innerHTML legth so far
3177 $testingEllipsis = false; // checking if ellipses will make string longer/equal?
3178 $tagType = 0; // 0-open, 1-close
3179 $bracketState = 0; // 1-tag start, 2-tag name, 0-neither
3180 $entityState = 0; // 0-not entity, 1-entity
3181 $tag = $ret = ''; // accumulated tag name, accumulated result string
3182 $openTags = array(); // open tag stack
3183 $maybeState = null; // possible truncation state
3184
3185 $textLen = strlen( $text );
3186 $neLength = max( 0, $length - strlen( $ellipsis ) ); // non-ellipsis len if truncated
3187 for ( $pos = 0; true; ++$pos ) {
3188 # Consider truncation once the display length has reached the maximim.
3189 # We check if $dispLen > 0 to grab tags for the $neLength = 0 case.
3190 # Check that we're not in the middle of a bracket/entity...
3191 if ( $dispLen && $dispLen >= $neLength && $bracketState == 0 && !$entityState ) {
3192 if ( !$testingEllipsis ) {
3193 $testingEllipsis = true;
3194 # Save where we are; we will truncate here unless there turn out to
3195 # be so few remaining characters that truncation is not necessary.
3196 if ( !$maybeState ) { // already saved? ($neLength = 0 case)
3197 $maybeState = array( $ret, $openTags ); // save state
3198 }
3199 } elseif ( $dispLen > $length && $dispLen > strlen( $ellipsis ) ) {
3200 # String in fact does need truncation, the truncation point was OK.
3201 list( $ret, $openTags ) = $maybeState; // reload state
3202 $ret = $this->removeBadCharLast( $ret ); // multi-byte char fix
3203 $ret .= $ellipsis; // add ellipsis
3204 break;
3205 }
3206 }
3207 if ( $pos >= $textLen ) break; // extra iteration just for above checks
3208
3209 # Read the next char...
3210 $ch = $text[$pos];
3211 $lastCh = $pos ? $text[$pos - 1] : '';
3212 $ret .= $ch; // add to result string
3213 if ( $ch == '<' ) {
3214 $this->truncate_endBracket( $tag, $tagType, $lastCh, $openTags ); // for bad HTML
3215 $entityState = 0; // for bad HTML
3216 $bracketState = 1; // tag started (checking for backslash)
3217 } elseif ( $ch == '>' ) {
3218 $this->truncate_endBracket( $tag, $tagType, $lastCh, $openTags );
3219 $entityState = 0; // for bad HTML
3220 $bracketState = 0; // out of brackets
3221 } elseif ( $bracketState == 1 ) {
3222 if ( $ch == '/' ) {
3223 $tagType = 1; // close tag (e.g. "</span>")
3224 } else {
3225 $tagType = 0; // open tag (e.g. "<span>")
3226 $tag .= $ch;
3227 }
3228 $bracketState = 2; // building tag name
3229 } elseif ( $bracketState == 2 ) {
3230 if ( $ch != ' ' ) {
3231 $tag .= $ch;
3232 } else {
3233 // Name found (e.g. "<a href=..."), add on tag attributes...
3234 $pos += $this->truncate_skip( $ret, $text, "<>", $pos + 1 );
3235 }
3236 } elseif ( $bracketState == 0 ) {
3237 if ( $entityState ) {
3238 if ( $ch == ';' ) {
3239 $entityState = 0;
3240 $dispLen++; // entity is one displayed char
3241 }
3242 } else {
3243 if ( $neLength == 0 && !$maybeState ) {
3244 // Save state without $ch. We want to *hit* the first
3245 // display char (to get tags) but not *use* it if truncating.
3246 $maybeState = array( substr( $ret, 0, -1 ), $openTags );
3247 }
3248 if ( $ch == '&' ) {
3249 $entityState = 1; // entity found, (e.g. "&#160;")
3250 } else {
3251 $dispLen++; // this char is displayed
3252 // Add the next $max display text chars after this in one swoop...
3253 $max = ( $testingEllipsis ? $length : $neLength ) - $dispLen;
3254 $skipped = $this->truncate_skip( $ret, $text, "<>&", $pos + 1, $max );
3255 $dispLen += $skipped;
3256 $pos += $skipped;
3257 }
3258 }
3259 }
3260 }
3261 // Close the last tag if left unclosed by bad HTML
3262 $this->truncate_endBracket( $tag, $text[$textLen - 1], $tagType, $openTags );
3263 while ( count( $openTags ) > 0 ) {
3264 $ret .= '</' . array_pop( $openTags ) . '>'; // close open tags
3265 }
3266 return $ret;
3267 }
3268
3269 /**
3270 * truncateHtml() helper function
3271 * like strcspn() but adds the skipped chars to $ret
3272 *
3273 * @param $ret
3274 * @param $text
3275 * @param $search
3276 * @param $start
3277 * @param $len
3278 * @return int
3279 */
3280 private function truncate_skip( &$ret, $text, $search, $start, $len = null ) {
3281 if ( $len === null ) {
3282 $len = -1; // -1 means "no limit" for strcspn
3283 } elseif ( $len < 0 ) {
3284 $len = 0; // sanity
3285 }
3286 $skipCount = 0;
3287 if ( $start < strlen( $text ) ) {
3288 $skipCount = strcspn( $text, $search, $start, $len );
3289 $ret .= substr( $text, $start, $skipCount );
3290 }
3291 return $skipCount;
3292 }
3293
3294 /**
3295 * truncateHtml() helper function
3296 * (a) push or pop $tag from $openTags as needed
3297 * (b) clear $tag value
3298 * @param &$tag string Current HTML tag name we are looking at
3299 * @param $tagType int (0-open tag, 1-close tag)
3300 * @param $lastCh string Character before the '>' that ended this tag
3301 * @param &$openTags array Open tag stack (not accounting for $tag)
3302 */
3303 private function truncate_endBracket( &$tag, $tagType, $lastCh, &$openTags ) {
3304 $tag = ltrim( $tag );
3305 if ( $tag != '' ) {
3306 if ( $tagType == 0 && $lastCh != '/' ) {
3307 $openTags[] = $tag; // tag opened (didn't close itself)
3308 } elseif ( $tagType == 1 ) {
3309 if ( $openTags && $tag == $openTags[count( $openTags ) - 1] ) {
3310 array_pop( $openTags ); // tag closed
3311 }
3312 }
3313 $tag = '';
3314 }
3315 }
3316
3317 /**
3318 * Grammatical transformations, needed for inflected languages
3319 * Invoked by putting {{grammar:case|word}} in a message
3320 *
3321 * @param $word string
3322 * @param $case string
3323 * @return string
3324 */
3325 function convertGrammar( $word, $case ) {
3326 global $wgGrammarForms;
3327 if ( isset( $wgGrammarForms[$this->getCode()][$case][$word] ) ) {
3328 return $wgGrammarForms[$this->getCode()][$case][$word];
3329 }
3330 return $word;
3331 }
3332 /**
3333 * Get the grammar forms for the content language
3334 * @return array of grammar forms
3335 * @since 1.20
3336 */
3337 function getGrammarForms() {
3338 global $wgGrammarForms;
3339 if ( isset( $wgGrammarForms[$this->getCode()] ) && is_array( $wgGrammarForms[$this->getCode()] ) ) {
3340 return $wgGrammarForms[$this->getCode()];
3341 }
3342 return array();
3343 }
3344 /**
3345 * Provides an alternative text depending on specified gender.
3346 * Usage {{gender:username|masculine|feminine|neutral}}.
3347 * username is optional, in which case the gender of current user is used,
3348 * but only in (some) interface messages; otherwise default gender is used.
3349 *
3350 * If no forms are given, an empty string is returned. If only one form is
3351 * given, it will be returned unconditionally. These details are implied by
3352 * the caller and cannot be overridden in subclasses.
3353 *
3354 * If more than one form is given, the default is to use the neutral one
3355 * if it is specified, and to use the masculine one otherwise. These
3356 * details can be overridden in subclasses.
3357 *
3358 * @param $gender string
3359 * @param $forms array
3360 *
3361 * @return string
3362 */
3363 function gender( $gender, $forms ) {
3364 if ( !count( $forms ) ) {
3365 return '';
3366 }
3367 $forms = $this->preConvertPlural( $forms, 2 );
3368 if ( $gender === 'male' ) {
3369 return $forms[0];
3370 }
3371 if ( $gender === 'female' ) {
3372 return $forms[1];
3373 }
3374 return isset( $forms[2] ) ? $forms[2] : $forms[0];
3375 }
3376
3377 /**
3378 * Plural form transformations, needed for some languages.
3379 * For example, there are 3 form of plural in Russian and Polish,
3380 * depending on "count mod 10". See [[w:Plural]]
3381 * For English it is pretty simple.
3382 *
3383 * Invoked by putting {{plural:count|wordform1|wordform2}}
3384 * or {{plural:count|wordform1|wordform2|wordform3}}
3385 *
3386 * Example: {{plural:{{NUMBEROFARTICLES}}|article|articles}}
3387 *
3388 * @param $count Integer: non-localized number
3389 * @param $forms Array: different plural forms
3390 * @return string Correct form of plural for $count in this language
3391 */
3392 function convertPlural( $count, $forms ) {
3393 if ( !count( $forms ) ) {
3394 return '';
3395 }
3396 $forms = $this->preConvertPlural( $forms, 2 );
3397
3398 return ( $count == 1 ) ? $forms[0] : $forms[1];
3399 }
3400
3401 /**
3402 * Checks that convertPlural was given an array and pads it to requested
3403 * amount of forms by copying the last one.
3404 *
3405 * @param $count Integer: How many forms should there be at least
3406 * @param $forms Array of forms given to convertPlural
3407 * @return array Padded array of forms or an exception if not an array
3408 */
3409 protected function preConvertPlural( /* Array */ $forms, $count ) {
3410 while ( count( $forms ) < $count ) {
3411 $forms[] = $forms[count( $forms ) - 1];
3412 }
3413 return $forms;
3414 }
3415
3416 /**
3417 * @todo Maybe translate block durations. Note that this function is somewhat misnamed: it
3418 * deals with translating the *duration* ("1 week", "4 days", etc), not the expiry time
3419 * (which is an absolute timestamp). Please note: do NOT add this blindly, as it is used
3420 * on old expiry lengths recorded in log entries. You'd need to provide the start date to
3421 * match up with it.
3422 *
3423 * @param $str String: the validated block duration in English
3424 * @return string Somehow translated block duration
3425 * @see LanguageFi.php for example implementation
3426 */
3427 function translateBlockExpiry( $str ) {
3428 $duration = SpecialBlock::getSuggestedDurations( $this );
3429 foreach ( $duration as $show => $value ) {
3430 if ( strcmp( $str, $value ) == 0 ) {
3431 return htmlspecialchars( trim( $show ) );
3432 }
3433 }
3434
3435 // Since usually only infinite or indefinite is only on list, so try
3436 // equivalents if still here.
3437 $indefs = array( 'infinite', 'infinity', 'indefinite' );
3438 if ( in_array( $str, $indefs ) ) {
3439 foreach ( $indefs as $val ) {
3440 $show = array_search( $val, $duration, true );
3441 if ( $show !== false ) {
3442 return htmlspecialchars( trim( $show ) );
3443 }
3444 }
3445 }
3446 // If all else fails, return the original string.
3447 return $str;
3448 }
3449
3450 /**
3451 * languages like Chinese need to be segmented in order for the diff
3452 * to be of any use
3453 *
3454 * @param $text String
3455 * @return String
3456 */
3457 public function segmentForDiff( $text ) {
3458 return $text;
3459 }
3460
3461 /**
3462 * and unsegment to show the result
3463 *
3464 * @param $text String
3465 * @return String
3466 */
3467 public function unsegmentForDiff( $text ) {
3468 return $text;
3469 }
3470
3471 /**
3472 * Return the LanguageConverter used in the Language
3473 *
3474 * @since 1.19
3475 * @return LanguageConverter
3476 */
3477 public function getConverter() {
3478 return $this->mConverter;
3479 }
3480
3481 /**
3482 * convert text to all supported variants
3483 *
3484 * @param $text string
3485 * @return array
3486 */
3487 public function autoConvertToAllVariants( $text ) {
3488 return $this->mConverter->autoConvertToAllVariants( $text );
3489 }
3490
3491 /**
3492 * convert text to different variants of a language.
3493 *
3494 * @param $text string
3495 * @return string
3496 */
3497 public function convert( $text ) {
3498 return $this->mConverter->convert( $text );
3499 }
3500
3501 /**
3502 * Convert a Title object to a string in the preferred variant
3503 *
3504 * @param $title Title
3505 * @return string
3506 */
3507 public function convertTitle( $title ) {
3508 return $this->mConverter->convertTitle( $title );
3509 }
3510
3511 /**
3512 * Check if this is a language with variants
3513 *
3514 * @return bool
3515 */
3516 public function hasVariants() {
3517 return sizeof( $this->getVariants() ) > 1;
3518 }
3519
3520 /**
3521 * Check if the language has the specific variant
3522 *
3523 * @since 1.19
3524 * @param $variant string
3525 * @return bool
3526 */
3527 public function hasVariant( $variant ) {
3528 return (bool)$this->mConverter->validateVariant( $variant );
3529 }
3530
3531 /**
3532 * Put custom tags (e.g. -{ }-) around math to prevent conversion
3533 *
3534 * @param $text string
3535 * @return string
3536 */
3537 public function armourMath( $text ) {
3538 return $this->mConverter->armourMath( $text );
3539 }
3540
3541 /**
3542 * Perform output conversion on a string, and encode for safe HTML output.
3543 * @param $text String text to be converted
3544 * @param $isTitle Bool whether this conversion is for the article title
3545 * @return string
3546 * @todo this should get integrated somewhere sane
3547 */
3548 public function convertHtml( $text, $isTitle = false ) {
3549 return htmlspecialchars( $this->convert( $text, $isTitle ) );
3550 }
3551
3552 /**
3553 * @param $key string
3554 * @return string
3555 */
3556 public function convertCategoryKey( $key ) {
3557 return $this->mConverter->convertCategoryKey( $key );
3558 }
3559
3560 /**
3561 * Get the list of variants supported by this language
3562 * see sample implementation in LanguageZh.php
3563 *
3564 * @return array an array of language codes
3565 */
3566 public function getVariants() {
3567 return $this->mConverter->getVariants();
3568 }
3569
3570 /**
3571 * @return string
3572 */
3573 public function getPreferredVariant() {
3574 return $this->mConverter->getPreferredVariant();
3575 }
3576
3577 /**
3578 * @return string
3579 */
3580 public function getDefaultVariant() {
3581 return $this->mConverter->getDefaultVariant();
3582 }
3583
3584 /**
3585 * @return string
3586 */
3587 public function getURLVariant() {
3588 return $this->mConverter->getURLVariant();
3589 }
3590
3591 /**
3592 * If a language supports multiple variants, it is
3593 * possible that non-existing link in one variant
3594 * actually exists in another variant. this function
3595 * tries to find it. See e.g. LanguageZh.php
3596 *
3597 * @param $link String: the name of the link
3598 * @param $nt Mixed: the title object of the link
3599 * @param $ignoreOtherCond Boolean: to disable other conditions when
3600 * we need to transclude a template or update a category's link
3601 * @return null the input parameters may be modified upon return
3602 */
3603 public function findVariantLink( &$link, &$nt, $ignoreOtherCond = false ) {
3604 $this->mConverter->findVariantLink( $link, $nt, $ignoreOtherCond );
3605 }
3606
3607 /**
3608 * If a language supports multiple variants, converts text
3609 * into an array of all possible variants of the text:
3610 * 'variant' => text in that variant
3611 *
3612 * @deprecated since 1.17 Use autoConvertToAllVariants()
3613 *
3614 * @param $text string
3615 *
3616 * @return string
3617 */
3618 public function convertLinkToAllVariants( $text ) {
3619 return $this->mConverter->convertLinkToAllVariants( $text );
3620 }
3621
3622 /**
3623 * returns language specific options used by User::getPageRenderHash()
3624 * for example, the preferred language variant
3625 *
3626 * @return string
3627 */
3628 function getExtraHashOptions() {
3629 return $this->mConverter->getExtraHashOptions();
3630 }
3631
3632 /**
3633 * For languages that support multiple variants, the title of an
3634 * article may be displayed differently in different variants. this
3635 * function returns the apporiate title defined in the body of the article.
3636 *
3637 * @return string
3638 */
3639 public function getParsedTitle() {
3640 return $this->mConverter->getParsedTitle();
3641 }
3642
3643 /**
3644 * Enclose a string with the "no conversion" tag. This is used by
3645 * various functions in the Parser
3646 *
3647 * @param $text String: text to be tagged for no conversion
3648 * @param $noParse bool
3649 * @return string the tagged text
3650 */
3651 public function markNoConversion( $text, $noParse = false ) {
3652 return $this->mConverter->markNoConversion( $text, $noParse );
3653 }
3654
3655 /**
3656 * A regular expression to match legal word-trailing characters
3657 * which should be merged onto a link of the form [[foo]]bar.
3658 *
3659 * @return string
3660 */
3661 public function linkTrail() {
3662 return self::$dataCache->getItem( $this->mCode, 'linkTrail' );
3663 }
3664
3665 /**
3666 * @return Language
3667 */
3668 function getLangObj() {
3669 return $this;
3670 }
3671
3672 /**
3673 * Get the RFC 3066 code for this language object
3674 *
3675 * @return string
3676 */
3677 public function getCode() {
3678 return $this->mCode;
3679 }
3680
3681 /**
3682 * Get the code in Bcp47 format which we can use
3683 * inside of html lang="" tags.
3684 * @since 1.19
3685 * @return string
3686 */
3687 public function getHtmlCode() {
3688 if ( is_null( $this->mHtmlCode ) ) {
3689 $this->mHtmlCode = wfBCP47( $this->getCode() );
3690 }
3691 return $this->mHtmlCode;
3692 }
3693
3694 /**
3695 * @param $code string
3696 */
3697 public function setCode( $code ) {
3698 $this->mCode = $code;
3699 // Ensure we don't leave an incorrect html code lying around
3700 $this->mHtmlCode = null;
3701 }
3702
3703 /**
3704 * Get the name of a file for a certain language code
3705 * @param $prefix string Prepend this to the filename
3706 * @param $code string Language code
3707 * @param $suffix string Append this to the filename
3708 * @throws MWException
3709 * @return string $prefix . $mangledCode . $suffix
3710 */
3711 public static function getFileName( $prefix = 'Language', $code, $suffix = '.php' ) {
3712 // Protect against path traversal
3713 if ( !Language::isValidCode( $code )
3714 || strcspn( $code, ":/\\\000" ) !== strlen( $code ) )
3715 {
3716 throw new MWException( "Invalid language code \"$code\"" );
3717 }
3718
3719 return $prefix . str_replace( '-', '_', ucfirst( $code ) ) . $suffix;
3720 }
3721
3722 /**
3723 * Get the language code from a file name. Inverse of getFileName()
3724 * @param $filename string $prefix . $languageCode . $suffix
3725 * @param $prefix string Prefix before the language code
3726 * @param $suffix string Suffix after the language code
3727 * @return string Language code, or false if $prefix or $suffix isn't found
3728 */
3729 public static function getCodeFromFileName( $filename, $prefix = 'Language', $suffix = '.php' ) {
3730 $m = null;
3731 preg_match( '/' . preg_quote( $prefix, '/' ) . '([A-Z][a-z_]+)' .
3732 preg_quote( $suffix, '/' ) . '/', $filename, $m );
3733 if ( !count( $m ) ) {
3734 return false;
3735 }
3736 return str_replace( '_', '-', strtolower( $m[1] ) );
3737 }
3738
3739 /**
3740 * @param $code string
3741 * @return string
3742 */
3743 public static function getMessagesFileName( $code ) {
3744 global $IP;
3745 $file = self::getFileName( "$IP/languages/messages/Messages", $code, '.php' );
3746 wfRunHooks( 'Language::getMessagesFileName', array( $code, &$file ) );
3747 return $file;
3748 }
3749
3750 /**
3751 * @param $code string
3752 * @return string
3753 */
3754 public static function getClassFileName( $code ) {
3755 global $IP;
3756 return self::getFileName( "$IP/languages/classes/Language", $code, '.php' );
3757 }
3758
3759 /**
3760 * Get the first fallback for a given language.
3761 *
3762 * @param $code string
3763 *
3764 * @return bool|string
3765 */
3766 public static function getFallbackFor( $code ) {
3767 if ( $code === 'en' || !Language::isValidBuiltInCode( $code ) ) {
3768 return false;
3769 } else {
3770 $fallbacks = self::getFallbacksFor( $code );
3771 $first = array_shift( $fallbacks );
3772 return $first;
3773 }
3774 }
3775
3776 /**
3777 * Get the ordered list of fallback languages.
3778 *
3779 * @since 1.19
3780 * @param $code string Language code
3781 * @return array
3782 */
3783 public static function getFallbacksFor( $code ) {
3784 if ( $code === 'en' || !Language::isValidBuiltInCode( $code ) ) {
3785 return array();
3786 } else {
3787 $v = self::getLocalisationCache()->getItem( $code, 'fallback' );
3788 $v = array_map( 'trim', explode( ',', $v ) );
3789 if ( $v[count( $v ) - 1] !== 'en' ) {
3790 $v[] = 'en';
3791 }
3792 return $v;
3793 }
3794 }
3795
3796 /**
3797 * Get all messages for a given language
3798 * WARNING: this may take a long time. If you just need all message *keys*
3799 * but need the *contents* of only a few messages, consider using getMessageKeysFor().
3800 *
3801 * @param $code string
3802 *
3803 * @return array
3804 */
3805 public static function getMessagesFor( $code ) {
3806 return self::getLocalisationCache()->getItem( $code, 'messages' );
3807 }
3808
3809 /**
3810 * Get a message for a given language
3811 *
3812 * @param $key string
3813 * @param $code string
3814 *
3815 * @return string
3816 */
3817 public static function getMessageFor( $key, $code ) {
3818 return self::getLocalisationCache()->getSubitem( $code, 'messages', $key );
3819 }
3820
3821 /**
3822 * Get all message keys for a given language. This is a faster alternative to
3823 * array_keys( Language::getMessagesFor( $code ) )
3824 *
3825 * @since 1.19
3826 * @param $code string Language code
3827 * @return array of message keys (strings)
3828 */
3829 public static function getMessageKeysFor( $code ) {
3830 return self::getLocalisationCache()->getSubItemList( $code, 'messages' );
3831 }
3832
3833 /**
3834 * @param $talk
3835 * @return mixed
3836 */
3837 function fixVariableInNamespace( $talk ) {
3838 if ( strpos( $talk, '$1' ) === false ) {
3839 return $talk;
3840 }
3841
3842 global $wgMetaNamespace;
3843 $talk = str_replace( '$1', $wgMetaNamespace, $talk );
3844
3845 # Allow grammar transformations
3846 # Allowing full message-style parsing would make simple requests
3847 # such as action=raw much more expensive than they need to be.
3848 # This will hopefully cover most cases.
3849 $talk = preg_replace_callback( '/{{grammar:(.*?)\|(.*?)}}/i',
3850 array( &$this, 'replaceGrammarInNamespace' ), $talk );
3851 return str_replace( ' ', '_', $talk );
3852 }
3853
3854 /**
3855 * @param $m string
3856 * @return string
3857 */
3858 function replaceGrammarInNamespace( $m ) {
3859 return $this->convertGrammar( trim( $m[2] ), trim( $m[1] ) );
3860 }
3861
3862 /**
3863 * @throws MWException
3864 * @return array
3865 */
3866 static function getCaseMaps() {
3867 static $wikiUpperChars, $wikiLowerChars;
3868 if ( isset( $wikiUpperChars ) ) {
3869 return array( $wikiUpperChars, $wikiLowerChars );
3870 }
3871
3872 wfProfileIn( __METHOD__ );
3873 $arr = wfGetPrecompiledData( 'Utf8Case.ser' );
3874 if ( $arr === false ) {
3875 throw new MWException(
3876 "Utf8Case.ser is missing, please run \"make\" in the serialized directory\n" );
3877 }
3878 $wikiUpperChars = $arr['wikiUpperChars'];
3879 $wikiLowerChars = $arr['wikiLowerChars'];
3880 wfProfileOut( __METHOD__ );
3881 return array( $wikiUpperChars, $wikiLowerChars );
3882 }
3883
3884 /**
3885 * Decode an expiry (block, protection, etc) which has come from the DB
3886 *
3887 * @FIXME: why are we returnings DBMS-dependent strings???
3888 *
3889 * @param $expiry String: Database expiry String
3890 * @param $format Bool|Int true to process using language functions, or TS_ constant
3891 * to return the expiry in a given timestamp
3892 * @return String
3893 */
3894 public function formatExpiry( $expiry, $format = true ) {
3895 static $infinity, $infinityMsg;
3896 if ( $infinity === null ) {
3897 $infinityMsg = wfMessage( 'infiniteblock' );
3898 $infinity = wfGetDB( DB_SLAVE )->getInfinity();
3899 }
3900
3901 if ( $expiry == '' || $expiry == $infinity ) {
3902 return $format === true
3903 ? $infinityMsg
3904 : $infinity;
3905 } else {
3906 return $format === true
3907 ? $this->timeanddate( $expiry, /* User preference timezone */ true )
3908 : wfTimestamp( $format, $expiry );
3909 }
3910 }
3911
3912 /**
3913 * @todo Document
3914 * @param $seconds int|float
3915 * @param $format Array Optional
3916 * If $format['avoid'] == 'avoidseconds' - don't mention seconds if $seconds >= 1 hour
3917 * If $format['avoid'] == 'avoidminutes' - don't mention seconds/minutes if $seconds > 48 hours
3918 * If $format['noabbrevs'] is true - use 'seconds' and friends instead of 'seconds-abbrev' and friends
3919 * For backwards compatibility, $format may also be one of the strings 'avoidseconds' or 'avoidminutes'
3920 * @return string
3921 */
3922 function formatTimePeriod( $seconds, $format = array() ) {
3923 if ( !is_array( $format ) ) {
3924 $format = array( 'avoid' => $format ); // For backwards compatibility
3925 }
3926 if ( !isset( $format['avoid'] ) ) {
3927 $format['avoid'] = false;
3928 }
3929 if ( !isset( $format['noabbrevs' ] ) ) {
3930 $format['noabbrevs'] = false;
3931 }
3932 $secondsMsg = wfMessage(
3933 $format['noabbrevs'] ? 'seconds' : 'seconds-abbrev' )->inLanguage( $this );
3934 $minutesMsg = wfMessage(
3935 $format['noabbrevs'] ? 'minutes' : 'minutes-abbrev' )->inLanguage( $this );
3936 $hoursMsg = wfMessage(
3937 $format['noabbrevs'] ? 'hours' : 'hours-abbrev' )->inLanguage( $this );
3938 $daysMsg = wfMessage(
3939 $format['noabbrevs'] ? 'days' : 'days-abbrev' )->inLanguage( $this );
3940
3941 if ( round( $seconds * 10 ) < 100 ) {
3942 $s = $this->formatNum( sprintf( "%.1f", round( $seconds * 10 ) / 10 ) );
3943 $s = $secondsMsg->params( $s )->text();
3944 } elseif ( round( $seconds ) < 60 ) {
3945 $s = $this->formatNum( round( $seconds ) );
3946 $s = $secondsMsg->params( $s )->text();
3947 } elseif ( round( $seconds ) < 3600 ) {
3948 $minutes = floor( $seconds / 60 );
3949 $secondsPart = round( fmod( $seconds, 60 ) );
3950 if ( $secondsPart == 60 ) {
3951 $secondsPart = 0;
3952 $minutes++;
3953 }
3954 $s = $minutesMsg->params( $this->formatNum( $minutes ) )->text();
3955 $s .= ' ';
3956 $s .= $secondsMsg->params( $this->formatNum( $secondsPart ) )->text();
3957 } elseif ( round( $seconds ) <= 2 * 86400 ) {
3958 $hours = floor( $seconds / 3600 );
3959 $minutes = floor( ( $seconds - $hours * 3600 ) / 60 );
3960 $secondsPart = round( $seconds - $hours * 3600 - $minutes * 60 );
3961 if ( $secondsPart == 60 ) {
3962 $secondsPart = 0;
3963 $minutes++;
3964 }
3965 if ( $minutes == 60 ) {
3966 $minutes = 0;
3967 $hours++;
3968 }
3969 $s = $hoursMsg->params( $this->formatNum( $hours ) )->text();
3970 $s .= ' ';
3971 $s .= $minutesMsg->params( $this->formatNum( $minutes ) )->text();
3972 if ( !in_array( $format['avoid'], array( 'avoidseconds', 'avoidminutes' ) ) ) {
3973 $s .= ' ' . $secondsMsg->params( $this->formatNum( $secondsPart ) )->text();
3974 }
3975 } else {
3976 $days = floor( $seconds / 86400 );
3977 if ( $format['avoid'] === 'avoidminutes' ) {
3978 $hours = round( ( $seconds - $days * 86400 ) / 3600 );
3979 if ( $hours == 24 ) {
3980 $hours = 0;
3981 $days++;
3982 }
3983 $s = $daysMsg->params( $this->formatNum( $days ) )->text();
3984 $s .= ' ';
3985 $s .= $hoursMsg->params( $this->formatNum( $hours ) )->text();
3986 } elseif ( $format['avoid'] === 'avoidseconds' ) {
3987 $hours = floor( ( $seconds - $days * 86400 ) / 3600 );
3988 $minutes = round( ( $seconds - $days * 86400 - $hours * 3600 ) / 60 );
3989 if ( $minutes == 60 ) {
3990 $minutes = 0;
3991 $hours++;
3992 }
3993 if ( $hours == 24 ) {
3994 $hours = 0;
3995 $days++;
3996 }
3997 $s = $daysMsg->params( $this->formatNum( $days ) )->text();
3998 $s .= ' ';
3999 $s .= $hoursMsg->params( $this->formatNum( $hours ) )->text();
4000 $s .= ' ';
4001 $s .= $minutesMsg->params( $this->formatNum( $minutes ) )->text();
4002 } else {
4003 $s = $daysMsg->params( $this->formatNum( $days ) )->text();
4004 $s .= ' ';
4005 $s .= $this->formatTimePeriod( $seconds - $days * 86400, $format );
4006 }
4007 }
4008 return $s;
4009 }
4010
4011 /**
4012 * Format a bitrate for output, using an appropriate
4013 * unit (bps, kbps, Mbps, Gbps, Tbps, Pbps, Ebps, Zbps or Ybps) according to the magnitude in question
4014 *
4015 * This use base 1000. For base 1024 use formatSize(), for another base
4016 * see formatComputingNumbers()
4017 *
4018 * @param $bps int
4019 * @return string
4020 */
4021 function formatBitrate( $bps ) {
4022 return $this->formatComputingNumbers( $bps, 1000, "bitrate-$1bits" );
4023 }
4024
4025 /**
4026 * @param $size int Size of the unit
4027 * @param $boundary int Size boundary (1000, or 1024 in most cases)
4028 * @param $messageKey string Message key to be uesd
4029 * @return string
4030 */
4031 function formatComputingNumbers( $size, $boundary, $messageKey ) {
4032 if ( $size <= 0 ) {
4033 return str_replace( '$1', $this->formatNum( $size ),
4034 $this->getMessageFromDB( str_replace( '$1', '', $messageKey ) )
4035 );
4036 }
4037 $sizes = array( '', 'kilo', 'mega', 'giga', 'tera', 'peta', 'exa', 'zeta', 'yotta' );
4038 $index = 0;
4039
4040 $maxIndex = count( $sizes ) - 1;
4041 while ( $size >= $boundary && $index < $maxIndex ) {
4042 $index++;
4043 $size /= $boundary;
4044 }
4045
4046 // For small sizes no decimal places necessary
4047 $round = 0;
4048 if ( $index > 1 ) {
4049 // For MB and bigger two decimal places are smarter
4050 $round = 2;
4051 }
4052 $msg = str_replace( '$1', $sizes[$index], $messageKey );
4053
4054 $size = round( $size, $round );
4055 $text = $this->getMessageFromDB( $msg );
4056 return str_replace( '$1', $this->formatNum( $size ), $text );
4057 }
4058
4059 /**
4060 * Format a size in bytes for output, using an appropriate
4061 * unit (B, KB, MB, GB, TB, PB, EB, ZB or YB) according to the magnitude in question
4062 *
4063 * This method use base 1024. For base 1000 use formatBitrate(), for
4064 * another base see formatComputingNumbers()
4065 *
4066 * @param $size int Size to format
4067 * @return string Plain text (not HTML)
4068 */
4069 function formatSize( $size ) {
4070 return $this->formatComputingNumbers( $size, 1024, "size-$1bytes" );
4071 }
4072
4073 /**
4074 * Make a list item, used by various special pages
4075 *
4076 * @param $page String Page link
4077 * @param $details String Text between brackets
4078 * @param $oppositedm Boolean Add the direction mark opposite to your
4079 * language, to display text properly
4080 * @return String
4081 */
4082 function specialList( $page, $details, $oppositedm = true ) {
4083 $dirmark = ( $oppositedm ? $this->getDirMark( true ) : '' ) .
4084 $this->getDirMark();
4085 $details = $details ? $dirmark . $this->getMessageFromDB( 'word-separator' ) .
4086 wfMsgExt( 'parentheses', array( 'escape', 'replaceafter', 'language' => $this ), $details ) : '';
4087 return $page . $details;
4088 }
4089
4090 /**
4091 * Generate (prev x| next x) (20|50|100...) type links for paging
4092 *
4093 * @param $title Title object to link
4094 * @param $offset Integer offset parameter
4095 * @param $limit Integer limit parameter
4096 * @param $query String optional URL query parameter string
4097 * @param $atend Bool optional param for specified if this is the last page
4098 * @return String
4099 */
4100 public function viewPrevNext( Title $title, $offset, $limit, array $query = array(), $atend = false ) {
4101 // @todo FIXME: Why on earth this needs one message for the text and another one for tooltip?
4102
4103 # Make 'previous' link
4104 $prev = wfMessage( 'prevn' )->inLanguage( $this )->title( $title )->numParams( $limit )->text();
4105 if ( $offset > 0 ) {
4106 $plink = $this->numLink( $title, max( $offset - $limit, 0 ), $limit,
4107 $query, $prev, 'prevn-title', 'mw-prevlink' );
4108 } else {
4109 $plink = htmlspecialchars( $prev );
4110 }
4111
4112 # Make 'next' link
4113 $next = wfMessage( 'nextn' )->inLanguage( $this )->title( $title )->numParams( $limit )->text();
4114 if ( $atend ) {
4115 $nlink = htmlspecialchars( $next );
4116 } else {
4117 $nlink = $this->numLink( $title, $offset + $limit, $limit,
4118 $query, $next, 'prevn-title', 'mw-nextlink' );
4119 }
4120
4121 # Make links to set number of items per page
4122 $numLinks = array();
4123 foreach ( array( 20, 50, 100, 250, 500 ) as $num ) {
4124 $numLinks[] = $this->numLink( $title, $offset, $num,
4125 $query, $this->formatNum( $num ), 'shown-title', 'mw-numlink' );
4126 }
4127
4128 return wfMessage( 'viewprevnext' )->inLanguage( $this )->title( $title
4129 )->rawParams( $plink, $nlink, $this->pipeList( $numLinks ) )->escaped();
4130 }
4131
4132 /**
4133 * Helper function for viewPrevNext() that generates links
4134 *
4135 * @param $title Title object to link
4136 * @param $offset Integer offset parameter
4137 * @param $limit Integer limit parameter
4138 * @param $query Array extra query parameters
4139 * @param $link String text to use for the link; will be escaped
4140 * @param $tooltipMsg String name of the message to use as tooltip
4141 * @param $class String value of the "class" attribute of the link
4142 * @return String HTML fragment
4143 */
4144 private function numLink( Title $title, $offset, $limit, array $query, $link, $tooltipMsg, $class ) {
4145 $query = array( 'limit' => $limit, 'offset' => $offset ) + $query;
4146 $tooltip = wfMessage( $tooltipMsg )->inLanguage( $this )->title( $title )->numParams( $limit )->text();
4147 return Html::element( 'a', array( 'href' => $title->getLocalURL( $query ),
4148 'title' => $tooltip, 'class' => $class ), $link );
4149 }
4150
4151 /**
4152 * Get the conversion rule title, if any.
4153 *
4154 * @return string
4155 */
4156 public function getConvRuleTitle() {
4157 return $this->mConverter->getConvRuleTitle();
4158 }
4159 }
Wiklou, le Wiki du Wiklou