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