includes/resourceloader/ResourceLoaderUserTokensModule.php

   1 <?php
   2 /**
   3  * Resource loader module for user tokens.
   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 Krinkle
  22  */
  23
  24 /**
  25  * Module for user tokens
  26  */
  27 class ResourceLoaderUserTokensModule extends ResourceLoaderModule {
  28
  29         /* Protected Members */
  30
  31         protected $origin = self::ORIGIN_CORE_INDIVIDUAL;
  32
  33         /* Methods */
  34
  35         /**
  36          * Fetch the tokens for the current user.
  37          *
  38          * @return array: List of tokens keyed by token type
  39          */
  40         protected function contextUserTokens() {
  41                 global $wgUser;
  42
  43                 return array(
  44                         'editToken' => $wgUser->getEditToken(),
  45                         'patrolToken' => ApiQueryRecentChanges::getPatrolToken( null, null ),
  46                         'watchToken' => ApiQueryInfo::getWatchToken( null, null ),
  47                 );
  48         }
  49
  50         /**
  51          * @param $context ResourceLoaderContext
  52          * @return string
  53          */
  54         public function getScript( ResourceLoaderContext $context ) {
  55                 return Xml::encodeJsCall( 'mw.user.tokens.set',
  56                         array( $this->contextUserTokens() ),
  57                         ResourceLoader::inDebugMode()
  58                 );
  59         }
  60
  61         /**
  62          * @return bool
  63          */
  64         public function supportsURLLoading() {
  65                 return false;
  66         }
  67
  68         /**
  69          * @return string
  70          */
  71         public function getGroup() {
  72                 return 'private';
  73         }
  74 }