includes/api/ApiDisabled.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 /**
  28  * API module that dies with an error immediately.
  29  *
  30  * Use this to disable core modules with
  31  * $wgAPIModules['modulename'] = 'ApiDisabled';
  32  *
  33  * To disable submodules of action=query, use ApiQueryDisabled instead
  34  *
  35  * @ingroup API
  36  */
  37 class ApiDisabled extends ApiBase {
  38
  39         public function execute() {
  40                 $this->dieUsage( "The \"{$this->getModuleName()}\" module has been disabled.", 'moduledisabled' );
  41         }
  42
  43         public function isReadMode() {
  44                 return false;
  45         }
  46
  47         public function getAllowedParams() {
  48                 return array();
  49         }
  50
  51         public function getParamDescription() {
  52                 return array();
  53         }
  54
  55         public function getDescription() {
  56                 return 'This module has been disabled';
  57         }
  58
  59         public function getExamples() {
  60                 return array();
  61         }
  62 }