4 * Created on Dec 01, 2007
6 * API for MediaWiki 1.8+
8 * Copyright (C) 2008 Roan Kattouw <Firstname>.<Lastname>@home.nl
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 * http://www.gnu.org/copyleft/gpl.html
26 if (!defined('MEDIAWIKI')) {
27 // Eclipse helper - will be ignored in production
28 require_once ("ApiBase.php");
34 class ApiParamInfo
extends ApiBase
{
36 public function __construct($main, $action) {
37 parent
:: __construct($main, $action);
40 public function execute() {
42 $params = $this->extractRequestParams();
43 $result = $this->getResult();
44 $queryObj = new ApiQuery($this->getMain(), 'query');
46 if(is_array($params['modules']))
48 $modArr = $this->getMain()->getModules();
49 $r['modules'] = array();
50 foreach($params['modules'] as $m)
52 if(!isset($modArr[$m]))
54 $r['modules'][] = array('name' => $m, 'missing' => '');
57 $obj = new $modArr[$m]($this->getMain(), $m);
58 $a = $this->getClassInfo($obj);
62 $result->setIndexedTagName($r['modules'], 'module');
64 if(is_array($params['querymodules']))
66 $qmodArr = $queryObj->getModules();
67 $r['querymodules'] = array();
68 foreach($params['querymodules'] as $qm)
70 if(!isset($qmodArr[$qm]))
72 $r['querymodules'][] = array('name' => $qm, 'missing' => '');
75 $obj = new $qmodArr[$qm]($this, $qm);
76 $a = $this->getClassInfo($obj);
78 $r['querymodules'][] = $a;
80 $result->setIndexedTagName($r['querymodules'], 'module');
82 if($params['mainmodule'])
83 $r['mainmodule'] = $this->getClassInfo($this->getMain());
84 if($params['pagesetmodule'])
86 $pageSet = new ApiPageSet($queryObj);
87 $r['pagesetmodule'] = $this->getClassInfo($pageSet);
89 $result->addValue(null, $this->getModuleName(), $r);
92 function getClassInfo($obj)
94 $result = $this->getResult();
95 $retval['classname'] = get_class($obj);
96 $retval['description'] = implode("\n", (array)$obj->getDescription());
97 $retval['version'] = implode("\n", (array)$obj->getVersion());
98 $retval['prefix'] = $obj->getModulePrefix();
99 if($obj->isReadMode())
100 $retval['readrights'] = '';
101 if($obj->isWriteMode())
102 $retval['writerights'] = '';
103 if($obj->mustBePosted())
104 $retval['mustbeposted'] = '';
105 if($obj instanceof ApiQueryGeneratorBase
)
106 $retval['generator'] = '';
107 $allowedParams = $obj->getFinalParams();
108 if(!is_array($allowedParams))
110 $retval['parameters'] = array();
111 $paramDesc = $obj->getFinalParamDescription();
112 foreach($allowedParams as $n => $p)
114 $a = array('name' => $n);
115 if(isset($paramDesc[$n]))
116 $a['description'] = implode("\n", (array)$paramDesc[$n]);
117 if(isset($p[ApiBase
::PARAM_DEPRECATED
]) && $p[ApiBase
::PARAM_DEPRECATED
])
118 $a['deprecated'] = '';
124 $a['default'] = ($p ?
'true' : 'false');
126 else if(is_string($p) ||
is_null($p))
128 $a['type'] = 'string';
129 $a['default'] = strval($p);
133 $a['type'] = 'integer';
134 $a['default'] = intval($p);
136 $retval['parameters'][] = $a;
140 if(isset($p[ApiBase
::PARAM_DFLT
]))
141 $a['default'] = $p[ApiBase
::PARAM_DFLT
];
142 if(isset($p[ApiBase
::PARAM_ISMULTI
]))
143 if($p[ApiBase
::PARAM_ISMULTI
])
146 $a['limit'] = $this->getMain()->canApiHighLimits() ?
147 ApiBase
::LIMIT_SML2
:
150 if(isset($p[ApiBase
::PARAM_ALLOW_DUPLICATES
]))
151 if($p[ApiBase
::PARAM_ALLOW_DUPLICATES
])
152 $a['allowsduplicates'] = '';
153 if(isset($p[ApiBase
::PARAM_TYPE
]))
155 $a['type'] = $p[ApiBase
::PARAM_TYPE
];
156 if(is_array($a['type']))
157 $result->setIndexedTagName($a['type'], 't');
159 if(isset($p[ApiBase
::PARAM_MAX
]))
160 $a['max'] = $p[ApiBase
::PARAM_MAX
];
161 if(isset($p[ApiBase
::PARAM_MAX2
]))
162 $a['highmax'] = $p[ApiBase
::PARAM_MAX2
];
163 if(isset($p[ApiBase
::PARAM_MIN
]))
164 $a['min'] = $p[ApiBase
::PARAM_MIN
];
165 $retval['parameters'][] = $a;
167 $result->setIndexedTagName($retval['parameters'], 'param');
171 public function isReadMode() {
175 public function getAllowedParams() {
178 ApiBase
:: PARAM_ISMULTI
=> true
180 'querymodules' => array(
181 ApiBase
:: PARAM_ISMULTI
=> true
183 'mainmodule' => false,
184 'pagesetmodule' => false,
188 public function getParamDescription() {
190 'modules' => 'List of module names (value of the action= parameter)',
191 'querymodules' => 'List of query module names (value of prop=, meta= or list= parameter)',
192 'mainmodule' => 'Get information about the main (top-level) module as well',
193 'pagesetmodule' => 'Get information about the pageset module (providing titles= and friends) as well',
197 public function getDescription() {
198 return 'Obtain information about certain API parameters';
201 protected function getExamples() {
203 'api.php?action=paraminfo&modules=parse&querymodules=allpages|siteinfo'
207 public function getVersion() {
208 return __CLASS__
. ': $Id$';