includes/resourceloader/ResourceLoaderUserOptionsModule.php

   1 <?php
   2 /**
   3  * ResourceLoader 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 $origin = self::ORIGIN_CORE_INDIVIDUAL;
  31
  32         protected $targets = [ 'desktop', 'mobile' ];
  33
  34         /**
  35          * @param ResourceLoaderContext|null $context
  36          * @return array List of module names as strings
  37          */
  38         public function getDependencies( ResourceLoaderContext $context = null ) {
  39                 return [ 'user.defaults' ];
  40         }
  41
  42         /**
  43          * @return bool
  44          */
  45         public function enableModuleContentVersion() {
  46                 return true;
  47         }
  48
  49         /**
  50          * @param ResourceLoaderContext $context
  51          * @return string JavaScript code
  52          */
  53         public function getScript( ResourceLoaderContext $context ) {
  54                 // Use FILTER_NOMIN annotation to prevent needless minification and caching (T84960).
  55                 return ResourceLoader::FILTER_NOMIN
  56                         . 'mw.user.options.set('
  57                         . ResourceLoader::encodeJsonForScript(
  58                                 $context->getUserObj()->getOptions( User::GETOPTIONS_EXCLUDE_DEFAULTS )
  59                         )
  60                         . ');';
  61         }
  62
  63         /**
  64          * @return bool
  65          */
  66         public function supportsURLLoading() {
  67                 return false;
  68         }
  69
  70         /**
  71          * @param ResourceLoaderContext $context
  72          * @return bool
  73          */
  74         public function isKnownEmpty( ResourceLoaderContext $context ) {
  75                 return !$context->getUserObj()->getOptions( User::GETOPTIONS_EXCLUDE_DEFAULTS );
  76         }
  77
  78         /**
  79          * @return string
  80          */
  81         public function getGroup() {
  82                 return 'private';
  83         }
  84 }