includes/api/ApiParamInfo.php

   1 <?php
   2
   3 /*
   4  * Created on Dec 01, 2007
   5  *
   6  * API for MediaWiki 1.8+
   7  *
   8  * Copyright (C) 2008 Roan Kattouw <Firstname>.<Lastname>@home.nl
   9  *
  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.
  14  *
  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.
  19  *
  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
  24  */
  25
  26 if (!defined('MEDIAWIKI')) {
  27         // Eclipse helper - will be ignored in production
  28         require_once ("ApiBase.php");
  29 }
  30
  31 /**
  32  * @addtogroup API
  33  */
  34 class ApiParamInfo extends ApiBase {
  35
  36         public function __construct($main, $action) {
  37                 parent :: __construct($main, $action);
  38         }
  39
  40         public function execute() {
  41                 // Get parameters
  42                 $params = $this->extractRequestParams();
  43                 $result = $this->getResult();
  44                 $r = array();
  45                 if(is_array($params['modules']))
  46                         foreach($params['modules'] as $m)
  47                         {
  48                                 $className = "Api$m";
  49                                 if(!class_exists($className))
  50                                 {
  51                                         $mods[$m] = array('missing' => '');
  52                                         continue;
  53                                 }
  54                                 $obj = new $className($this->getMain(), $m);
  55                                 $r['modules'][$m] = $this->getClassInfo($obj);
  56                         }
  57                 if(is_array($params['querymodules']))
  58                         foreach($params['querymodules'] as $qm)
  59                         {
  60                                 $className = "ApiQuery$qm";
  61                                 if(!class_exists($className))
  62                                 {
  63                                         $qmods[$qm] = array('missing' => '');
  64                                         continue;
  65                                 }
  66                                 $obj = new $className($this, $qm);
  67                                 $r['querymodules'][$qm] = $this->getClassInfo($obj);
  68                         }
  69                 $result->addValue( null, $this->getModuleName(), $r );
  70         }
  71
  72         function getClassInfo($obj)
  73         {
  74                 $result = $this->getResult();
  75                 $retval['classname'] = get_class($obj);
  76                 $retval['description'] = (is_array($obj->getDescription()) ? implode("\n", $obj->getDescription()) : $obj->getDescription());
  77                 $retval['prefix'] = $obj->getModulePrefix();
  78                 $allowedParams = $obj->getAllowedParams();
  79                 if(!is_array($allowedParams))
  80                         return $retval;
  81                 $retval['parameters'] = array();
  82                 $paramDesc = $obj->getParamDescription();
  83                 foreach($obj->getAllowedParams() as $n => $p)
  84                 {
  85                         $a = array('name' => $n);
  86                         if(!is_array($p))
  87                         {
  88                                 if(is_bool($p))
  89                                 {
  90                                         $a['type'] = 'bool';
  91                                         $a['default'] = ($p ? 'true' : 'false');
  92                                 }
  93                                 if(is_string($p))
  94                                         $a['default'] = $p;
  95                                 $retval['parameters'][] = $a;
  96                                 continue;
  97                         }
  98
  99                         if(isset($p[ApiBase::PARAM_DFLT]))
 100                                 $a['default'] = $p[ApiBase::PARAM_DFLT];
 101                         if(isset($p[ApiBase::PARAM_ISMULTI]))
 102                                 if($p[ApiBase::PARAM_ISMULTI])
 103                                         $a['multi'] = '';
 104                         if(isset($p[ApiBase::PARAM_TYPE]))
 105                         {
 106                                 $a['type'] = $p[ApiBase::PARAM_TYPE];
 107                                 if(is_array($a['type']))
 108                                         $result->setIndexedTagName($a['type'], 't');
 109                         }
 110                         if(isset($p[ApiBase::PARAM_MAX]))
 111                                 $a['max'] = $p[ApiBase::PARAM_MAX];
 112                         if(isset($p[ApiBase::PARAM_MAX2]))
 113                                 $a['highmax'] = $p[ApiBase::PARAM_MAX2];
 114                         if(isset($p[ApiBase::PARAM_MIN]))
 115                                 $a['min'] = $p[ApiBase::PARAM_MIN];
 116                         if(isset($paramDesc[$n]))
 117                                 $a['description'] = (is_array($paramDesc[$n]) ? implode("\n", $paramDesc[$n]) : $paramDesc[$n]);
 118                         $retval['parameters'][] = $a;
 119                 }
 120                 $result->setIndexedTagName($retval['parameters'], 'param');
 121                 return $retval;
 122         }
 123
 124         protected function getAllowedParams() {
 125                 return array (
 126                         'modules' => array(
 127                                 ApiBase :: PARAM_ISMULTI => true
 128                         ),
 129                         'querymodules' => array(
 130                                 ApiBase :: PARAM_ISMULTI => true
 131                         )
 132                 );
 133         }
 134
 135         protected function getParamDescription() {
 136                 return array (
 137                         'modules' => 'List of module names (value of the action= parameter)',
 138                         'querymodules' => 'List of query module names (value of prop=, meta= or list= parameter)',
 139                 );
 140         }
 141
 142         protected function getDescription() {
 143                 return 'Obtain information about certain API parameters';
 144         }
 145
 146         protected function getExamples() {
 147                 return array (
 148                         'api.php?action=paraminfo&modules=parse&querymodules=allpages|siteinfo'
 149                 );
 150         }
 151
 152         public function getVersion() {
 153                 return __CLASS__ . ': $Id: ApiParse.php 29810 2008-01-15 21:33:08Z catrope $';
 154         }
 155 }
 156