cc527023d13a07558139639b82e1a9658a3de3e4
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();
45 if(is_array($params['modules']))
46 foreach($params['modules'] as $m)
49 if(!class_exists($className))
51 $mods[$m] = array('missing' => '');
54 $obj = new $className($this->getMain(), $m);
55 $r['modules'][$m] = $this->getClassInfo($obj);
57 if(is_array($params['querymodules']))
58 foreach($params['querymodules'] as $qm)
60 $className = "ApiQuery$qm";
61 if(!class_exists($className))
63 $qmods[$qm] = array('missing' => '');
66 $obj = new $className($this, 'query');
67 $r['querymodules'][$qm] = $this->getClassInfo($obj);
69 $result->addValue( null, $this->getModuleName(), $r );
72 function getClassInfo($obj)
74 $result = $this->getResult();
75 $retval['classname'] = get_class($obj);
76 $retval['description'] = (is_array($obj->getDescription()) ?
implode("\n", $obj->getDescription()) : $obj->getDescription());
77 $allowedParams = $obj->getAllowedParams();
78 if(!is_array($allowedParams))
80 $retval['parameters'] = array();
81 foreach($obj->getAllowedParams() as $n => $p)
83 $a = array('name' => $n);
89 $a['default'] = ($p ?
'true' : 'false');
93 $retval['parameters'][] = $a;
97 if(isset($p[ApiBase
::PARAM_DFLT
]))
98 $a['default'] = $p[ApiBase
::PARAM_DFLT
];
99 if(isset($p[ApiBase
::PARAM_ISMULTI
]))
100 if($p[ApiBase
::PARAM_ISMULTI
])
102 if(isset($p[ApiBase
::PARAM_TYPE
]))
104 $a['type'] = $p[ApiBase
::PARAM_TYPE
];
105 if(is_array($a['type']))
106 $result->setIndexedTagName($a['type'], 't');
108 if(isset($p[ApiBase
::PARAM_MAX
]))
109 $a['max'] = $p[ApiBase
::PARAM_MAX
];
110 if(isset($p[ApiBase
::PARAM_MAX2
]))
111 $a['highmax'] = $p[ApiBase
::PARAM_MAX2
];
112 if(isset($p[ApiBase
::PARAM_MIN
]))
113 $a['min'] = $p[ApiBase
::PARAM_MIN
];
114 $retval['parameters'][] = $a;
116 $result->setIndexedTagName($retval['parameters'], 'param');
120 protected function getAllowedParams() {
123 ApiBase
:: PARAM_ISMULTI
=> true
125 'querymodules' => array(
126 ApiBase
:: PARAM_ISMULTI
=> true
131 protected function getParamDescription() {
133 'modules' => 'List of module names (value of the action= parameter)',
134 'querymodules' => 'List of query module names (value of prop=, meta= or list= parameter)',
138 protected function getDescription() {
139 return 'Obtain information about certain API parameters';
142 protected function getExamples() {
144 'api.php?action=paraminfo&modules=parse&querymodules=allpages|siteinfo'
148 public function getVersion() {
149 return __CLASS__
. ': $Id: ApiParse.php 29810 2008-01-15 21:33:08Z catrope $';