wiki.techinc.nl/includes/resourceloader/ResourceLoaderUserTokensModule.php
Ori Livneh ca30efa30a resourceloader: cache minified user and site modules
* Add support for a '/* @nomin */' annotation in ResourceLoader. If present in
  JavaScript or CSS, the code will not be minified or cached. This allows
  modules like the ResourceLoaderUserTokensModule to declare themselves unfit
  for minification / caching without requiring a complicated refactor.
* Make ResourceLoader::filter() static, at the cost of not having minifier
  errors in the ResourceLoader log bucket. (They will continue to be logged as
  exceptions, however).

Change-Id: Ic1d802ee20565e61046bfbd8fd209bc56a4cbd6c
2015-10-03 20:29:48 +00:00

83 lines
2.1 KiB
PHP

<?php
/**
* Resource loader module for user tokens.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @author Krinkle
*/
/**
* Module for user tokens
*/
class ResourceLoaderUserTokensModule extends ResourceLoaderModule {
/* Protected Members */
protected $origin = self::ORIGIN_CORE_INDIVIDUAL;
protected $targets = array( 'desktop', 'mobile' );
/* Methods */
/**
* Fetch the tokens for the current user.
*
* @param ResourceLoaderContext $context
* @return array List of tokens keyed by token type
*/
protected function contextUserTokens( ResourceLoaderContext $context ) {
$user = $context->getUserObj();
return array(
'editToken' => $user->getEditToken(),
'patrolToken' => $user->getEditToken( 'patrol' ),
'watchToken' => $user->getEditToken( 'watch' ),
);
}
/**
* Generate the JavaScript content of this module.
*
* Add '@nomin' annotation to prevent the module's contents from getting
* cached (T84960).
*
* @param ResourceLoaderContext $context
* @return string
*/
public function getScript( ResourceLoaderContext $context ) {
return Xml::encodeJsCall(
'mw.user.tokens.set',
array( $this->contextUserTokens( $context ) ),
ResourceLoader::inDebugMode()
) . ResourceLoader::FILTER_NOMIN;
}
/**
* @return bool
*/
public function supportsURLLoading() {
return false;
}
/**
* @return string
*/
public function getGroup() {
return 'private';
}
}