4 * Created on Sep 25, 2008
5 * API for MediaWiki 1.8+
7 * Copyright (C) 2008 Roan Kattouw <Firstname>.<Lastname>@home.nl
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.
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.
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 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
22 * http://www.gnu.org/copyleft/gpl.html
25 if (!defined('MEDIAWIKI')) {
26 // Eclipse helper - will be ignored in production
27 require_once ("ApiBase.php");
32 * API module that does nothing
34 * Use this to disable core modules with e.g.
35 * $wgAPIPropModules['modulename'] = 'ApiQueryDisabled';
37 * To disable top-level modules, use ApiDisabled instead
41 class ApiQueryDisabled extends ApiQueryBase {
43 public function __construct($main, $action) {
44 parent :: __construct($main, $action);
47 public function execute() {
48 $this->setWarning("The ``{$this->getModuleName()}'' module has been disabled.");
51 public function getAllowedParams() {
55 public function getParamDescription() {
59 public function getDescription() {
61 'This module has been disabled.'
65 protected function getExamples() {
69 public function getVersion() {
70 return __CLASS__ . ': $Id: ApiQueryDisabled.php 41268 2008-09-25 20:50:50Z catrope $';