resources/mediawiki.language/mediawiki.language.js

   1 /**
   2  * Localized Language support attempts to mirror some of the functionality of
   3  * Language.php in MediaWiki.
   4  * This adds methods for transforming message text.
   5  */
   6 ( function ( mw, $ ) {
   7
   8 var language = {
   9
  10         /**
  11          * Process the PLURAL template substitution
  12          *
  13          * @param {object} template Template object
  14          * @format template
  15          *  {
  16          *      'title': [title of template],
  17          *      'parameters': [template parameters]
  18          *  }
  19          * @example {{Template:title|params}}
  20          */
  21         procPLURAL: function ( template ) {
  22                 if ( template.title && template.parameters && mw.language.convertPlural ) {
  23                         // Check if we have forms to replace
  24                         if ( template.parameters.length === 0 ) {
  25                                 return '';
  26                         }
  27                         // Restore the count into a Number ( if it got converted earlier )
  28                         var count = mw.language.convertNumber( template.title, true );
  29                         // Do convertPlural call
  30                         return mw.language.convertPlural( parseInt( count, 10 ), template.parameters );
  31                 }
  32                 // Could not process plural return first form or nothing
  33                 if ( template.parameters[0] ) {
  34                         return template.parameters[0];
  35                 }
  36                 return '';
  37         },
  38
  39         /**
  40          * Plural form transformations, needed for some languages.
  41          *
  42          * @param count integer Non-localized quantifier
  43          * @param forms array List of plural forms
  44          * @return string Correct form for quantifier in this language
  45          */
  46         convertPlural: function ( count, forms ) {
  47                 var pluralRules,
  48                         formCount,
  49                         form,
  50                         index,
  51                         equalsPosition,
  52                         pluralFormIndex = 0;
  53
  54                 if ( !forms || forms.length === 0 ) {
  55                         return '';
  56                 }
  57
  58                 // Handle for explicit n= forms
  59                 for ( index = 0; index < forms.length; index++ ) {
  60                         form = forms[index];
  61                         if ( /^\d+=/.test( form ) ) {
  62                                 equalsPosition = form.indexOf( '=' );
  63                                 formCount = parseInt( form.substring( 0, equalsPosition ), 10 );
  64                                 if ( formCount === count ) {
  65                                         return form.substr( equalsPosition + 1 );
  66                                 }
  67                                 forms[index] = undefined;
  68                         }
  69                 }
  70
  71                 // Remove explicit plural forms from the forms.
  72                 forms = $.map( forms, function ( form ) {
  73                         return form;
  74                 } );
  75
  76                 if ( forms.length === 0 ) {
  77                         return '';
  78                 }
  79
  80                 pluralRules = mw.language.getData( mw.config.get( 'wgUserLanguage' ), 'pluralRules' );
  81                 if ( !pluralRules ) {
  82                         // default fallback.
  83                         return ( count === 1 ) ? forms[0] : forms[1];
  84                 }
  85                 pluralFormIndex = mw.cldr.getPluralForm( count, pluralRules );
  86                 pluralFormIndex = Math.min( pluralFormIndex, forms.length - 1 );
  87                 return forms[pluralFormIndex];
  88         },
  89
  90         /**
  91          * Pads an array to a specific length by copying the last one element.
  92          *
  93          * @param forms array Number of forms given to convertPlural
  94          * @param count integer Number of forms required
  95          * @return array Padded array of forms
  96          */
  97         preConvertPlural: function ( forms, count ) {
  98                 while ( forms.length < count ) {
  99                         forms.push( forms[ forms.length-1 ] );
 100                 }
 101                 return forms;
 102         },
 103
 104         /**
 105          * Provides an alternative text depending on specified gender.
 106          * Usage {{gender:[gender|user object]|masculine|feminine|neutral}}.
 107          * If second or third parameter are not specified, masculine is used.
 108          *
 109          * These details may be overriden per language.
 110          *
 111          * @param gender string male, female, or anything else for neutral.
 112          * @param forms array List of gender forms
 113          *
 114          * @return string
 115          */
 116         gender: function ( gender, forms ) {
 117                 if ( !forms || forms.length === 0 ) {
 118                         return '';
 119                 }
 120                 forms = mw.language.preConvertPlural( forms, 2 );
 121                 if ( gender === 'male' ) {
 122                         return forms[0];
 123                 }
 124                 if ( gender === 'female' ) {
 125                         return forms[1];
 126                 }
 127                 return ( forms.length === 3 ) ? forms[2] : forms[0];
 128         },
 129
 130         /**
 131          * Grammatical transformations, needed for inflected languages.
 132          * Invoked by putting {{grammar:form|word}} in a message.
 133          * The rules can be defined in $wgGrammarForms global or grammar
 134          * forms can be computed dynamically by overriding this method per language
 135          *
 136          * @param word {String}
 137          * @param form {String}
 138          * @return {String}
 139          */
 140         convertGrammar: function ( word, form ) {
 141                 var grammarForms = mw.language.getData( mw.config.get( 'wgUserLanguage' ), 'grammarForms' );
 142                 if ( grammarForms && grammarForms[form] ) {
 143                         return grammarForms[form][word] || word;
 144                 }
 145                 return word;
 146         }
 147
 148 };
 149
 150 $.extend( mw.language, language );
 151
 152 }( mediaWiki, jQuery ) );