includes/api/ApiQueryDisabled.php

   1 <?php
   2 /**
   3  *
   4  *
   5  * Created on Sep 25, 2008
   6  *
   7  * Copyright © 2008 Roan Kattouw <Firstname>.<Lastname>@gmail.com
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, write to the Free Software Foundation, Inc.,
  21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  22  * http://www.gnu.org/copyleft/gpl.html
  23  *
  24  * @file
  25  */
  26
  27 if ( !defined( 'MEDIAWIKI' ) ) {
  28         // Eclipse helper - will be ignored in production
  29         require_once( "ApiBase.php" );
  30 }
  31
  32 /**
  33  * API module that does nothing
  34  *
  35  * Use this to disable core modules with e.g.
  36  * $wgAPIPropModules['modulename'] = 'ApiQueryDisabled';
  37  *
  38  * To disable top-level modules, use ApiDisabled instead
  39  *
  40  * @ingroup API
  41  */
  42 class ApiQueryDisabled extends ApiQueryBase {
  43
  44         public function __construct( $main, $action ) {
  45                 parent::__construct( $main, $action );
  46         }
  47
  48         public function execute() {
  49                 $this->setWarning( "The ``{$this->getModuleName()}'' module has been disabled." );
  50         }
  51
  52         public function getAllowedParams() {
  53                 return array();
  54         }
  55
  56         public function getParamDescription() {
  57                 return array();
  58         }
  59
  60         public function getDescription() {
  61                 return array(
  62                         'This module has been disabled.'
  63                 );
  64         }
  65
  66         protected function getExamples() {
  67                 return array();
  68         }
  69
  70         public function getVersion() {
  71                 return __CLASS__ . ': $Id$';
  72         }
  73 }