4b2a2636d4c7bd17e8c346bbd5929f8d117b5a94
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'] = (is_array($obj->getDescription()) ?
implode("\n", $obj->getDescription()) : $obj->getDescription());
97 $retval['prefix'] = $obj->getModulePrefix();
98 if($obj->isReadMode())
99 $retval['readrights'] = '';
100 if($obj->isWriteMode())
101 $retval['writerights'] = '';
102 if($obj->mustBePosted())
103 $retval['mustbeposted'] = '';
104 $allowedParams = $obj->getFinalParams();
105 if(!is_array($allowedParams))
107 $retval['parameters'] = array();
108 $paramDesc = $obj->getFinalParamDescription();
109 foreach($allowedParams as $n => $p)
111 $a = array('name' => $n);
117 $a['default'] = ($p ?
'true' : 'false');
121 $retval['parameters'][] = $a;
125 if(isset($p[ApiBase
::PARAM_DFLT
]))
126 $a['default'] = $p[ApiBase
::PARAM_DFLT
];
127 if(isset($p[ApiBase
::PARAM_ISMULTI
]))
128 if($p[ApiBase
::PARAM_ISMULTI
])
131 $a['limit'] = $this->getMain()->canApiHighLimits() ?
132 ApiBase
::LIMIT_SML2
:
135 if(isset($p[ApiBase
::PARAM_ALLOW_DUPLICATES
]))
136 if($p[ApiBase
::PARAM_ALLOW_DUPLICATES
])
137 $a['allowsduplicates'] = '';
138 if(isset($p[ApiBase
::PARAM_TYPE
]))
140 $a['type'] = $p[ApiBase
::PARAM_TYPE
];
141 if(is_array($a['type']))
142 $result->setIndexedTagName($a['type'], 't');
144 if(isset($p[ApiBase
::PARAM_MAX
]))
145 $a['max'] = $p[ApiBase
::PARAM_MAX
];
146 if(isset($p[ApiBase
::PARAM_MAX2
]))
147 $a['highmax'] = $p[ApiBase
::PARAM_MAX2
];
148 if(isset($p[ApiBase
::PARAM_MIN
]))
149 $a['min'] = $p[ApiBase
::PARAM_MIN
];
150 if(isset($paramDesc[$n]))
151 $a['description'] = (is_array($paramDesc[$n]) ?
implode("\n", $paramDesc[$n]) : $paramDesc[$n]);
152 $retval['parameters'][] = $a;
154 $result->setIndexedTagName($retval['parameters'], 'param');
158 public function isReadMode() {
162 public function getAllowedParams() {
165 ApiBase
:: PARAM_ISMULTI
=> true
167 'querymodules' => array(
168 ApiBase
:: PARAM_ISMULTI
=> true
170 'mainmodule' => false,
171 'pagesetmodule' => false,
175 public function getParamDescription() {
177 'modules' => 'List of module names (value of the action= parameter)',
178 'querymodules' => 'List of query module names (value of prop=, meta= or list= parameter)',
179 'mainmodule' => 'Get information about the main (top-level) module as well',
180 'pagesetmodule' => 'Get information about the pageset module (providing titles= and friends) as well',
184 public function getDescription() {
185 return 'Obtain information about certain API parameters';
188 protected function getExamples() {
190 'api.php?action=paraminfo&modules=parse&querymodules=allpages|siteinfo'
194 public function getVersion() {
195 return __CLASS__
. ': $Id$';