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