Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
25.00% covered (danger)
25.00%
2 / 8
50.00% covered (danger)
50.00%
2 / 4
CRAP
0.00% covered (danger)
0.00%
0 / 1
ApiDisabled
28.57% covered (danger)
28.57%
2 / 7
50.00% covered (danger)
50.00%
2 / 4
9.83
0.00% covered (danger)
0.00%
0 / 1
 execute
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 isReadMode
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 getSummaryMessage
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 getExtendedDescription
0.00% covered (danger)
0.00%
0 / 4
0.00% covered (danger)
0.00%
0 / 1
2
1<?php
2/**
3 * Copyright © 2008 Roan Kattouw <roan.kattouw@gmail.com>
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
19 *
20 * @file
21 */
22
23namespace MediaWiki\Api;
24
25/**
26 * API module that dies with an error immediately.
27 *
28 * Use this to disable core modules with
29 * $wgAPIModules['modulename'] = 'ApiDisabled';
30 *
31 * To disable submodules of action=query, use ApiQueryDisabled instead
32 *
33 * @ingroup API
34 */
35class ApiDisabled extends ApiBase {
36
37    public function execute() {
38        $this->dieWithError( [ 'apierror-moduledisabled', $this->getModuleName() ] );
39    }
40
41    public function isReadMode() {
42        return false;
43    }
44
45    protected function getSummaryMessage() {
46        return 'apihelp-disabled-summary';
47    }
48
49    protected function getExtendedDescription() {
50        return [ [
51            'apihelp-disabled-extended-description',
52            'api-help-no-extended-description',
53        ] ];
54    }
55}
56
57/** @deprecated class alias since 1.43 */
58class_alias( ApiDisabled::class, 'ApiDisabled' );