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