includes/resourceloader/ResourceLoaderJqueryMsgDataModule.php

   1 <?php
   2 /**
   3  * Resource loader module for populating mediawiki.jqueryMsg data.
   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 Brad Jorsch
  22  */
  23
  24 /**
  25  * ResourceLoader module for populating mediawiki.jqueryMsg data.
  26  */
  27 class ResourceLoaderJqueryMsgDataModule extends ResourceLoaderModule {
  28
  29         protected $targets = array( 'desktop', 'mobile' );
  30
  31         /**
  32          * @param ResourceLoaderContext $context
  33          * @return string JavaScript code
  34          */
  35         public function getScript( ResourceLoaderContext $context ) {
  36                 $jsData = array();
  37
  38                 $tagData = Sanitizer::getRecognizedTagData();
  39                 $jsData['allowedHtmlElements'] = array_merge(
  40                         array_keys( $tagData['htmlpairs'] ),
  41                         array_diff(
  42                                 array_keys( $tagData['htmlsingle'] ),
  43                                 array_keys( $tagData['htmlsingleonly'] )
  44                         )
  45                 );
  46
  47                 return "if ( !mw.jqueryMsg ) {\n" .
  48                         "\tmw.jqueryMsg = {};\n" .
  49                         "}\n" .
  50                         "mw.jqueryMsg.data = " . Xml::encodeJsVar( $jsData ) . ";\n";
  51         }
  52
  53         /**
  54          * @param ResourceLoaderContext $context
  55          * @return array|null
  56          */
  57         public function getDefinitionSummary( ResourceLoaderContext $context ) {
  58                 $ret = parent::getDefinitionSummary( $context );
  59                 $ret['hash'] = md5( $this->getScript( $context ) );
  60                 return $ret;
  61         }
  62 }