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 foreach($params['modules'] as $m)
51 if(!isset($modArr[$m]))
53 $r['modules'][] = array('name' => $m, 'missing' => '');
56 $obj = new $modArr[$m]($this->getMain(), $m);
57 $a = $this->getClassInfo($obj);
61 $result->setIndexedTagName($r['modules'], 'module');
63 if(is_array($params['querymodules']))
65 $qmodArr = $queryObj->getModules();
66 foreach($params['querymodules'] as $qm)
68 if(!isset($qmodArr[$qm]))
70 $r['querymodules'][] = array('name' => $qm, 'missing' => '');
73 $obj = new $qmodArr[$qm]($this, $qm);
74 $a = $this->getClassInfo($obj);
76 $r['querymodules'][] = $a;
78 $result->setIndexedTagName($r['querymodules'], 'module');
80 if($params['mainmodule'])
81 $r['mainmodule'] = $this->getClassInfo($this->getMain());
82 if($params['pagesetmodule'])
84 $pageSet = new ApiPageSet($queryObj);
85 $r['pagesetmodule'] = $this->getClassInfo($pageSet);
87 $result->addValue(null, $this->getModuleName(), $r);
90 function getClassInfo($obj)
92 $result = $this->getResult();
93 $retval['classname'] = get_class($obj);
94 $retval['description'] = (is_array($obj->getDescription()) ?
implode("\n", $obj->getDescription()) : $obj->getDescription());
95 $retval['prefix'] = $obj->getModulePrefix();
96 $allowedParams = $obj->getFinalParams();
97 if(!is_array($allowedParams))
99 $retval['parameters'] = array();
100 $paramDesc = $obj->getFinalParamDescription();
101 foreach($allowedParams as $n => $p)
103 $a = array('name' => $n);
109 $a['default'] = ($p ?
'true' : 'false');
113 $retval['parameters'][] = $a;
117 if(isset($p[ApiBase
::PARAM_DFLT
]))
118 $a['default'] = $p[ApiBase
::PARAM_DFLT
];
119 if(isset($p[ApiBase
::PARAM_ISMULTI
]))
120 if($p[ApiBase
::PARAM_ISMULTI
])
123 $a['limit'] = $this->getMain()->canApiHighLimits() ?
124 ApiBase
::LIMIT_SML2
:
127 if(isset($p[ApiBase
::PARAM_ALLOW_DUPLICATES
]))
128 if($p[ApiBase
::PARAM_ALLOW_DUPLICATES
])
129 $a['allowsduplicates'] = '';
130 if(isset($p[ApiBase
::PARAM_TYPE
]))
132 $a['type'] = $p[ApiBase
::PARAM_TYPE
];
133 if(is_array($a['type']))
134 $result->setIndexedTagName($a['type'], 't');
136 if(isset($p[ApiBase
::PARAM_MAX
]))
137 $a['max'] = $p[ApiBase
::PARAM_MAX
];
138 if(isset($p[ApiBase
::PARAM_MAX2
]))
139 $a['highmax'] = $p[ApiBase
::PARAM_MAX2
];
140 if(isset($p[ApiBase
::PARAM_MIN
]))
141 $a['min'] = $p[ApiBase
::PARAM_MIN
];
142 if(isset($paramDesc[$n]))
143 $a['description'] = (is_array($paramDesc[$n]) ?
implode("\n", $paramDesc[$n]) : $paramDesc[$n]);
144 $retval['parameters'][] = $a;
146 $result->setIndexedTagName($retval['parameters'], 'param');
150 public function getAllowedParams() {
153 ApiBase
:: PARAM_ISMULTI
=> true
155 'querymodules' => array(
156 ApiBase
:: PARAM_ISMULTI
=> true
158 'mainmodule' => false,
159 'pagesetmodule' => false,
163 public function getParamDescription() {
165 'modules' => 'List of module names (value of the action= parameter)',
166 'querymodules' => 'List of query module names (value of prop=, meta= or list= parameter)',
167 'mainmodule' => 'Get information about the main (top-level) module as well',
168 'pagesetmodule' => 'Get information about the pageset module (providing titles= and friends) as well',
172 public function getDescription() {
173 return 'Obtain information about certain API parameters';
176 protected function getExamples() {
178 'api.php?action=paraminfo&modules=parse&querymodules=allpages|siteinfo'
182 public function getVersion() {
183 return __CLASS__
. ': $Id$';