includes/resourceloader/ResourceLoaderSiteModule.php

   1 <?php
   2 /**
   3  * Resource loader module for site customizations.
   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 Trevor Parscal
  22  * @author Roan Kattouw
  23  */
  24
  25 /**
  26  * Module for site customizations
  27  */
  28 class ResourceLoaderSiteModule extends ResourceLoaderWikiModule {
  29
  30         /* Protected Methods */
  31
  32         /**
  33          * Gets list of pages used by this module
  34          *
  35          * @param ResourceLoaderContext $context
  36          *
  37          * @return array List of pages
  38          */
  39         protected function getPages( ResourceLoaderContext $context ) {
  40                 $pages = array();
  41                 if ( $this->getConfig()->get( 'UseSiteJs' ) ) {
  42                         $pages['MediaWiki:Common.js'] = array( 'type' => 'script' );
  43                         $pages['MediaWiki:' . ucfirst( $context->getSkin() ) . '.js'] = array( 'type' => 'script' );
  44                 }
  45                 if ( $this->getConfig()->get( 'UseSiteCss' ) ) {
  46                         $pages['MediaWiki:Common.css'] = array( 'type' => 'style' );
  47                         $pages['MediaWiki:' . ucfirst( $context->getSkin() ) . '.css'] = array( 'type' => 'style' );
  48
  49                 }
  50                 $pages['MediaWiki:Print.css'] = array( 'type' => 'style', 'media' => 'print' );
  51                 return $pages;
  52         }
  53
  54         /* Methods */
  55
  56         /**
  57          * @param $context ResourceLoaderContext
  58          * @return array
  59          */
  60         public function getStyles( ResourceLoaderContext $context ) {
  61                 global $wgLogo;
  62
  63                 $styles = parent::getStyles( $context );
  64                 $styles['all'][] = '.mw-wiki-logo { background-image: ' .
  65                         CSSMin::buildUrlValue( $wgLogo ) .
  66                         '; }';
  67
  68                 return $styles;
  69         }
  70
  71         /**
  72          * @param $context ResourceLoaderContext
  73          * @return boolean
  74          */
  75         public function isKnownEmpty( ResourceLoaderContext $context ) {
  76                 // Regardless of whether the wiki page(s) exist, we always
  77                 // provide mw-wiki-logo styles.
  78                 return false;
  79         }
  80
  81         /**
  82          * @param $context ResourceLoaderContext
  83          * @return int|mixed
  84          */
  85         public function getModifiedTime( ResourceLoaderContext $context ) {
  86                 $parentMTime = parent::getModifiedTime( $context );
  87                 return max( $parentMTime, $this->getHashMtime( $context ) );
  88         }
  89
  90         /**
  91          * @param $context ResourceLoaderContext
  92          * @return string: Hash
  93          */
  94         public function getModifiedHash( ResourceLoaderContext $context ) {
  95                 global $wgLogo;
  96                 return md5( parent::getModifiedHash( $context ) . $wgLogo );
  97         }
  98
  99         /**
 100          * Gets group name
 101          *
 102          * @return string Name of group
 103          */
 104         public function getGroup() {
 105                 return 'site';
 106         }
 107 }