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                 if ( !forms || forms.length === 0 ) {
  48                         return '';
  49                 }
  50                 return ( parseInt( count, 10 ) === 1 ) ? forms[0] : forms[1];
  51         },
  52
  53         /**
  54          * Pads an array to a specific length by copying the last one element.
  55          *
  56          * @param forms array Number of forms given to convertPlural
  57          * @param count integer Number of forms required
  58          * @return array Padded array of forms
  59          */
  60         preConvertPlural: function ( forms, count ) {
  61                 while ( forms.length < count ) {
  62                         forms.push( forms[ forms.length-1 ] );
  63                 }
  64                 return forms;
  65         },
  66
  67         /**
  68          * Converts a number using digitTransformTable.
  69          *
  70          * @param {num} number Value to be converted
  71          * @param {boolean} integer Convert the return value to an integer
  72          */
  73         convertNumber: function( num, integer ) {
  74                 var i, tmp, transformTable;
  75
  76                 if ( !mw.language.digitTransformTable ) {
  77                         return num;
  78                 }
  79                 // Set the target Transform table:
  80                 transformTable = mw.language.digitTransformTable;
  81                 // Check if the "restore" to Latin number flag is set:
  82                 if ( integer ) {
  83                         if ( parseInt( num, 10 ) === num ) {
  84                                 return num;
  85                         }
  86                         tmp = [];
  87                         for ( i in transformTable ) {
  88                                 tmp[ transformTable[ i ] ] = i;
  89                         }
  90                         transformTable = tmp;
  91                 }
  92                 var numberString = '' + num;
  93                 var convertedNumber = '';
  94                 for ( i = 0; i < numberString.length; i++ ) {
  95                         if ( transformTable[ numberString[i] ] ) {
  96                                 convertedNumber += transformTable[numberString[i]];
  97                         } else {
  98                                 convertedNumber += numberString[i];
  99                         }
 100                 }
 101                 return integer ? parseInt( convertedNumber, 10 ) : convertedNumber;
 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         // Digit Transform Table, populated by language classes where applicable
 149         digitTransformTable: mw.language.getData( mw.config.get( 'wgUserLanguage' ), 'digitTransformTable' )
 150 };
 151
 152 $.extend( mw.language, language );
 153
 154 }( mediaWiki, jQuery ) );