includes/api/ApiDisabled.php

   1 <?php
   2
   3 /**
   4  * Created on Sep 25, 2008
   5  * API for MediaWiki 1.8+
   6  *
   7  * Copyright © 2008 Roan Kattouw <Firstname>.<Lastname>@home.nl
   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
  25 if ( !defined( 'MEDIAWIKI' ) ) {
  26         // Eclipse helper - will be ignored in production
  27         require_once( "ApiBase.php" );
  28 }
  29
  30 /**
  31  * API module that dies with an error immediately.
  32  *
  33  * Use this to disable core modules with
  34  * $wgAPIModules['modulename'] = 'ApiDisabled';
  35  *
  36  * To disable submodules of action=query, use ApiQueryDisabled instead
  37  *
  38  * @ingroup API
  39  */
  40 class ApiDisabled extends ApiBase {
  41
  42         public function __construct( $main, $action ) {
  43                 parent::__construct( $main, $action );
  44         }
  45
  46         public function execute() {
  47                 $this->dieUsage( "The ``{$this->getModuleName()}'' module has been disabled.", 'moduledisabled' );
  48         }
  49
  50         public function isReadMode() {
  51                 return false;
  52         }
  53
  54         public function getAllowedParams() {
  55                 return array();
  56         }
  57
  58         public function getParamDescription() {
  59                 return array();
  60         }
  61
  62         public function getDescription() {
  63                 return 'This module has been disabled';
  64         }
  65
  66         protected function getExamples() {
  67                 return array();
  68         }
  69
  70         public function getVersion() {
  71                 return __CLASS__ . ': $Id$';
  72         }
  73 }