includes/resourceloader/ResourceLoaderLanguageDataModule.php

   1 <?php
   2 /**
   3  * Resource loader 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.
  27  */
  28 class ResourceLoaderLanguageDataModule extends ResourceLoaderModule {
  29
  30         protected $language;
  31         /**
  32          * Get the grammar forms for the site content language.
  33          *
  34          * @return array
  35          */
  36         protected function getSiteLangGrammarForms() {
  37                 return $this->language->getGrammarForms();
  38         }
  39
  40         /**
  41          * Get the plural forms for the site content language.
  42          *
  43          * @return array
  44          */
  45         protected function getPluralRules() {
  46                 return $this->language->getPluralRules();
  47         }
  48
  49         /**
  50          * Get the digit transform table for the content language
  51          * Seperator transform table also required here to convert
  52          * the . and , sign to appropriate forms in content language.
  53          *
  54          * @return array
  55          */
  56         protected function getDigitTransformTable() {
  57                 $digitTransformTable = $this->language->digitTransformTable();
  58                 $separatorTransformTable = $this->language->separatorTransformTable();
  59                 if ( $digitTransformTable ) {
  60                         array_merge( $digitTransformTable, (array)$separatorTransformTable );
  61                 } else {
  62                         return $separatorTransformTable;
  63                 }
  64                 return $digitTransformTable;
  65         }
  66
  67         /**
  68          * Get all the dynamic data for the content language to an array
  69          *
  70          * @return array
  71          */
  72         protected function getData() {
  73                 return array(
  74                         'digitTransformTable' => $this->getDigitTransformTable(),
  75                         'grammarForms' => $this->getSiteLangGrammarForms(),
  76                         'pluralRules' => $this->getPluralRules(),
  77                 );
  78         }
  79
  80         /**
  81          * @param $context ResourceLoaderContext
  82          * @return string: JavaScript code
  83          */
  84         public function getScript( ResourceLoaderContext $context ) {
  85                 $this->language = Language::factory( $context->getLanguage() );
  86                 return Xml::encodeJsCall( 'mw.language.setData', array(
  87                         $this->language->getCode(),
  88                         $this->getData()
  89                 ) );
  90         }
  91
  92         /**
  93          * @param $context ResourceLoaderContext
  94          * @return array|int|Mixed
  95          */
  96         public function getModifiedTime( ResourceLoaderContext $context ) {
  97                 $this->language = Language::factory( $context ->getLanguage() );
  98                 $cache = wfGetCache( CACHE_ANYTHING );
  99                 $key = wfMemcKey( 'resourceloader', 'langdatamodule', 'changeinfo' );
 100
 101                 $data = $this->getData();
 102                 $hash = md5( serialize( $data ) );
 103
 104                 $result = $cache->get( $key );
 105                 if ( is_array( $result ) && $result['hash'] === $hash ) {
 106                         return $result['timestamp'];
 107                 }
 108                 $timestamp = wfTimestamp();
 109                 $cache->set( $key, array(
 110                         'hash' => $hash,
 111                         'timestamp' => $timestamp,
 112                 ) );
 113                 return $timestamp;
 114         }
 115
 116         /**
 117          * @return array
 118          */
 119         public function getDependencies() {
 120                 return array( 'mediawiki.language.init' );
 121         }
 122 }