diff options
Diffstat (limited to 'includes/api/ApiDisabled.php')
-rw-r--r-- | includes/api/ApiDisabled.php | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/includes/api/ApiDisabled.php b/includes/api/ApiDisabled.php new file mode 100644 index 00000000..40e38a0f --- /dev/null +++ b/includes/api/ApiDisabled.php @@ -0,0 +1,72 @@ +<?php + +/* + * Created on Sep 25, 2008 + * API for MediaWiki 1.8+ + * + * Copyright (C) 2008 Roan Kattouw <Firstname>.<Lastname>@home.nl + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * http://www.gnu.org/copyleft/gpl.html + */ + +if (!defined('MEDIAWIKI')) { + // Eclipse helper - will be ignored in production + require_once ("ApiBase.php"); +} + + +/** + * API module that dies with an error immediately. + * + * Use this to disable core modules with + * $wgAPIModules['modulename'] = 'ApiDisabled'; + * + * To disable submodules of action=query, use ApiQueryDisabled instead + * + * @ingroup API + */ +class ApiDisabled extends ApiBase { + + public function __construct($main, $action) { + parent :: __construct($main, $action); + } + + public function execute() { + $this->dieUsage("The ``{$this->getModuleName()}'' module has been disabled.", 'moduledisabled'); + } + + public function getAllowedParams() { + return array (); + } + + public function getParamDescription() { + return array (); + } + + public function getDescription() { + return array( + 'This module has been disabled.' + ); + } + + protected function getExamples() { + return array (); + } + + public function getVersion() { + return __CLASS__ . ': $Id: ApiDisabled.php 41268 2008-09-25 20:50:50Z catrope $'; + } +} |