1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
<?php
/**
*
*
* Created on Sep 6, 2006
*
* Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
*
* 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.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
/**
* This is a simple class to handle action=help
*
* @ingroup API
*/
class ApiHelp extends ApiBase {
public function __construct( $main, $action ) {
parent::__construct( $main, $action );
}
/**
* Module for displaying help
*/
public function execute() {
// Get parameters
$params = $this->extractRequestParams();
if ( !isset( $params['modules'] ) && !isset( $params['querymodules'] ) ) {
$this->dieUsage( '', 'help' );
}
$this->getMain()->setHelp();
$result = $this->getResult();
$queryObj = new ApiQuery( $this->getMain(), 'query' );
$r = array();
if ( is_array( $params['modules'] ) ) {
$modArr = $this->getMain()->getModules();
foreach ( $params['modules'] as $m ) {
if ( !isset( $modArr[$m] ) ) {
$r[] = array( 'name' => $m, 'missing' => '' );
continue;
}
$module = new $modArr[$m]( $this->getMain(), $m );
$r[] = $this->buildModuleHelp( $module, 'action' );
}
}
if ( is_array( $params['querymodules'] ) ) {
$qmodArr = $queryObj->getModules();
foreach ( $params['querymodules'] as $qm ) {
if ( !isset( $qmodArr[$qm] ) ) {
$r[] = array( 'name' => $qm, 'missing' => '' );
continue;
}
$module = new $qmodArr[$qm]( $this, $qm );
$type = $queryObj->getModuleType( $qm );
if ( $type === null ) {
$r[] = array( 'name' => $qm, 'missing' => '' );
continue;
}
$r[] = $this->buildModuleHelp( $module, $type );
}
}
$result->setIndexedTagName( $r, 'module' );
$result->addValue( null, $this->getModuleName(), $r );
}
/**
* @param $module ApiBase
* @param $type String What type of request is this? e.g. action, query, list, prop, meta, format
* @return string
*/
private function buildModuleHelp( $module, $type ) {
$msg = ApiMain::makeHelpMsgHeader( $module, $type );
$msg2 = $module->makeHelpMsg();
if ( $msg2 !== false ) {
$msg .= $msg2;
}
return $msg;
}
public function shouldCheckMaxlag() {
return false;
}
public function isReadMode() {
return false;
}
public function getAllowedParams() {
return array(
'modules' => array(
ApiBase::PARAM_ISMULTI => true
),
'querymodules' => array(
ApiBase::PARAM_ISMULTI => true
),
);
}
public function getParamDescription() {
return array(
'modules' => 'List of module names (value of the action= parameter)',
'querymodules' => 'List of query module names (value of prop=, meta= or list= parameter)',
);
}
public function getDescription() {
return 'Display this help screen. Or the help screen for the specified module';
}
public function getExamples() {
return array(
'api.php?action=help' => 'Whole help page',
'api.php?action=help&modules=protect' => 'Module (action) help page',
'api.php?action=help&querymodules=categorymembers' => 'Query (list) modules help page',
'api.php?action=help&querymodules=info' => 'Query (prop) modules help page',
'api.php?action=help&querymodules=siteinfo' => 'Query (meta) modules help page',
);
}
public function getHelpUrls() {
return array(
'https://www.mediawiki.org/wiki/API:Main_page',
'https://www.mediawiki.org/wiki/API:FAQ',
'https://www.mediawiki.org/wiki/API:Quick_start_guide',
);
}
public function getVersion() {
return __CLASS__ . ': $Id$';
}
}
|
