includes/resourceloader/ResourceLoaderLanguageDataModule.php

   1 <?php
   2 /**
   3  * ResourceLoader module for populating language specific data.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @author Santhosh Thottingal
  22  * @author Timo Tijhof
  23  */
  24
  25 /**
  26  * ResourceLoader module for populating language specific data, such as grammar forms.
  27  */
  28 class ResourceLoaderLanguageDataModule extends ResourceLoaderFileModule {
  29
  30         protected $targets = [ 'desktop', 'mobile' ];
  31
  32         /**
  33          * Get all the dynamic data for the content language to an array.
  34          *
  35          * @param ResourceLoaderContext $context
  36          * @return array
  37          */
  38         protected function getData( ResourceLoaderContext $context ) {
  39                 $language = Language::factory( $context->getLanguage() );
  40                 return [
  41                         'digitTransformTable' => $language->digitTransformTable(),
  42                         'separatorTransformTable' => $language->separatorTransformTable(),
  43                         'minimumGroupingDigits' => $language->minimumGroupingDigits(),
  44                         'grammarForms' => $language->getGrammarForms(),
  45                         'grammarTransformations' => $language->getGrammarTransformations(),
  46                         'pluralRules' => $language->getPluralRules(),
  47                         'digitGroupingPattern' => $language->digitGroupingPattern(),
  48                         'fallbackLanguages' => $language->getFallbackLanguages(),
  49                 ];
  50         }
  51
  52         /**
  53          * @param ResourceLoaderContext $context
  54          * @return string JavaScript code
  55          */
  56         public function getScript( ResourceLoaderContext $context ) {
  57                 $fileScript = parent::getScript( $context );
  58                 $langDataScript = Xml::encodeJsCall(
  59                         'mw.language.setData',
  60                         [
  61                                 $context->getLanguage(),
  62                                 $this->getData( $context )
  63                         ],
  64                         ResourceLoader::inDebugMode()
  65                 );
  66                 return $fileScript . $langDataScript;
  67         }
  68
  69         /**
  70          * @return bool
  71          */
  72         public function enableModuleContentVersion() {
  73                 return true;
  74         }
  75
  76         /**
  77          * @return bool
  78          */
  79         public function supportsURLLoading() {
  80                 return false;
  81         }
  82 }