includes/resourceloader/ResourceLoaderUserOptionsModule.php

   1 <?php
   2 /**
   3  * Resource loader module for user preference customizations.
   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 Trevor Parscal
  22  * @author Roan Kattouw
  23  */
  24
  25 /**
  26  * Module for user preference customizations
  27  */
  28 class ResourceLoaderUserOptionsModule extends ResourceLoaderModule {
  29
  30         /* Protected Members */
  31
  32         protected $modifiedTime = array();
  33
  34         protected $origin = self::ORIGIN_CORE_INDIVIDUAL;
  35
  36         protected $targets = array( 'desktop', 'mobile' );
  37
  38         /* Methods */
  39
  40         /**
  41          * @return array List of module names as strings
  42          */
  43         public function getDependencies() {
  44                 return array( 'user.defaults' );
  45         }
  46
  47         /**
  48          * @param ResourceLoaderContext $context
  49          * @return int
  50          */
  51         public function getModifiedTime( ResourceLoaderContext $context ) {
  52                 $hash = $context->getHash();
  53                 if ( !isset( $this->modifiedTime[$hash] ) ) {
  54                         $this->modifiedTime[$hash] = wfTimestamp( TS_UNIX, $context->getUserObj()->getTouched() );
  55                 }
  56
  57                 return $this->modifiedTime[$hash];
  58         }
  59
  60         /**
  61          * @param ResourceLoaderContext $context
  62          * @return string
  63          */
  64         public function getScript( ResourceLoaderContext $context ) {
  65                 return Xml::encodeJsCall( 'mw.user.options.set',
  66                         array( $context->getUserObj()->getOptions( User::GETOPTIONS_EXCLUDE_DEFAULTS ) ),
  67                         ResourceLoader::inDebugMode()
  68                 );
  69         }
  70
  71         /**
  72          * @return bool
  73          */
  74         public function supportsURLLoading() {
  75                 return false;
  76         }
  77
  78         /**
  79          * @return string
  80          */
  81         public function getGroup() {
  82                 return 'private';
  83         }
  84 }