includes/resourceloader/ResourceLoaderUserOptionsModule.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  * @author Trevor Parscal
  20  * @author Roan Kattouw
  21  */
  22
  23 /**
  24  * Module for user preferences.
  25  *
  26  * @ingroup ResourceLoader
  27  * @internal
  28  */
  29 class ResourceLoaderUserOptionsModule extends ResourceLoaderModule {
  30
  31         protected $origin = self::ORIGIN_CORE_INDIVIDUAL;
  32
  33         protected $targets = [ 'desktop', 'mobile' ];
  34
  35         /**
  36          * @param ResourceLoaderContext|null $context
  37          * @return array List of module names as strings
  38          */
  39         public function getDependencies( ResourceLoaderContext $context = null ) {
  40                 return [ 'user.defaults' ];
  41         }
  42
  43         /**
  44          * @return bool
  45          */
  46         public function enableModuleContentVersion() {
  47                 return true;
  48         }
  49
  50         /**
  51          * @param ResourceLoaderContext $context
  52          * @return string JavaScript code
  53          */
  54         public function getScript( ResourceLoaderContext $context ) {
  55                 // Use FILTER_NOMIN annotation to prevent needless minification and caching (T84960).
  56                 return ResourceLoader::FILTER_NOMIN
  57                         . 'mw.user.options.set('
  58                         . ResourceLoader::encodeJsonForScript(
  59                                 $context->getUserObj()->getOptions( User::GETOPTIONS_EXCLUDE_DEFAULTS )
  60                         )
  61                         . ');';
  62         }
  63
  64         /**
  65          * @return bool
  66          */
  67         public function supportsURLLoading() {
  68                 return false;
  69         }
  70
  71         /**
  72          * @param ResourceLoaderContext $context
  73          * @return bool
  74          */
  75         public function isKnownEmpty( ResourceLoaderContext $context ) {
  76                 return !$context->getUserObj()->getOptions( User::GETOPTIONS_EXCLUDE_DEFAULTS );
  77         }
  78
  79         /**
  80          * @return string
  81          */
  82         public function getGroup() {
  83                 return 'private';
  84         }
  85 }