API: Adding parameter description to action=paraminfo output
authorRoan Kattouw <catrope@users.mediawiki.org>
Wed, 23 Jan 2008 16:59:37 +0000 (16:59 +0000)
committerRoan Kattouw <catrope@users.mediawiki.org>
Wed, 23 Jan 2008 16:59:37 +0000 (16:59 +0000)
includes/api/ApiParamInfo.php

index cc52702..eb89ec5 100644 (file)
@@ -78,6 +78,7 @@ class ApiParamInfo extends ApiBase {
                if(!is_array($allowedParams))\r
                        return $retval;\r
                $retval['parameters'] = array();\r
+               $paramDesc = $obj->getParamDescription();\r
                foreach($obj->getAllowedParams() as $n => $p)\r
                {\r
                        $a = array('name' => $n);\r
@@ -111,6 +112,8 @@ class ApiParamInfo extends ApiBase {
                                $a['highmax'] = $p[ApiBase::PARAM_MAX2];\r
                        if(isset($p[ApiBase::PARAM_MIN]))\r
                                $a['min'] = $p[ApiBase::PARAM_MIN];\r
+                       if(isset($paramDesc[$n]))\r
+                               $a['description'] = (is_array($paramDesc[$n]) ? implode("\n", $paramDesc[$n]) : $paramDesc[$n]);\r
                        $retval['parameters'][] = $a;\r
                }\r
                $result->setIndexedTagName($retval['parameters'], 'param');\r