wiki.techinc.nl/includes/resourceloader/ResourceLoaderJqueryMsgModule.php
Bryan Davis aaf1e17088 Remove "@author Bryan Davis" and "Brad Jorsch" annotations
Undo traces of a practice we carried over from past projects and
existing examples that is neither universal nor actively encouraged in
the MediaWiki codebase.

Bug: T139301
Change-Id: I5c9c89b72a45a44aa4264a5e57b003c1a86cdf6e
Co-Authored-By: Brad Jorsch <bjorsch@wikimedia.org>
2017-06-26 15:25:46 -06:00

82 lines
2.4 KiB
PHP

<?php
/**
* ResourceLoader module for mediawiki.jqueryMsg that provides generated data.
*
* 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
*/
/**
* ResourceLoader module for mediawiki.jqueryMsg and its generated data
*/
class ResourceLoaderJqueryMsgModule extends ResourceLoaderFileModule {
/**
* @param ResourceLoaderContext $context
* @return string JavaScript code
*/
public function getScript( ResourceLoaderContext $context ) {
$fileScript = parent::getScript( $context );
$tagData = Sanitizer::getRecognizedTagData();
$parserDefaults = [];
$parserDefaults['allowedHtmlElements'] = array_merge(
array_keys( $tagData['htmlpairs'] ),
array_diff(
array_keys( $tagData['htmlsingle'] ),
array_keys( $tagData['htmlsingleonly'] )
)
);
$mainDataScript = Xml::encodeJsCall( 'mw.jqueryMsg.setParserDefaults', [ $parserDefaults ] );
// Associative array mapping magic words (e.g. SITENAME)
// to their values.
$magicWords = [
'SITENAME' => $this->getConfig()->get( 'Sitename' ),
];
Hooks::run( 'ResourceLoaderJqueryMsgModuleMagicWords', [ $context, &$magicWords ] );
$magicWordExtendData = [
'magic' => $magicWords,
];
$magicWordDataScript = Xml::encodeJsCall( 'mw.jqueryMsg.setParserDefaults', [
$magicWordExtendData,
/* deep= */ true
] );
return $fileScript . $mainDataScript . $magicWordDataScript;
}
/**
* @param ResourceLoaderContext $context
* @return array
*/
public function getScriptURLsForDebug( ResourceLoaderContext $context ) {
// Bypass file module urls
return ResourceLoaderModule::getScriptURLsForDebug( $context );
}
/**
* @return bool
*/
public function enableModuleContentVersion() {
return true;
}
}