-<?php\r
-\r
-/*\r
- * Created on Dec 01, 2007\r
- *\r
- * API for MediaWiki 1.8+\r
- *\r
- * Copyright (C) 2008 Roan Kattouw <Firstname>.<Lastname>@home.nl\r
- *\r
- * This program is free software; you can redistribute it and/or modify\r
- * it under the terms of the GNU General Public License as published by\r
- * the Free Software Foundation; either version 2 of the License, or\r
- * (at your option) any later version.\r
- *\r
- * This program is distributed in the hope that it will be useful,\r
- * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r
- * GNU General Public License for more details.\r
- *\r
- * You should have received a copy of the GNU General Public License along\r
- * with this program; if not, write to the Free Software Foundation, Inc.,\r
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.\r
- * http://www.gnu.org/copyleft/gpl.html\r
- */\r
-\r
-if (!defined('MEDIAWIKI')) {\r
- // Eclipse helper - will be ignored in production\r
- require_once ("ApiBase.php");\r
-}\r
-\r
-/**\r
- * @addtogroup API\r
- */\r
-class ApiParamInfo extends ApiBase {\r
-\r
- public function __construct($main, $action) {\r
- parent :: __construct($main, $action);\r
- }\r
-\r
- public function execute() {\r
- // Get parameters\r
- $params = $this->extractRequestParams();\r
- $result = $this->getResult();\r
- $r = array();\r
- if(is_array($params['modules']))\r
- {\r
- $modArr = $this->getMain()->getModules();\r
- foreach($params['modules'] as $m)\r
- {\r
- if(!isset($modArr[$m]))\r
- {\r
- $r['modules'][] = array('name' => $m, 'missing' => '');\r
- continue;\r
- }\r
- $obj = new $modArr[$m]($this->getMain(), $m);\r
- $a = $this->getClassInfo($obj);\r
- $a['name'] = $m;\r
- $r['modules'][] = $a; \r
- }\r
- $result->setIndexedTagName($r['modules'], 'module');\r
- }\r
- if(is_array($params['querymodules']))\r
- {\r
- $queryObj = new ApiQuery($this->getMain(), 'query');\r
- $qmodArr = $queryObj->getModules();\r
- foreach($params['querymodules'] as $qm)\r
- {\r
- if(!isset($qmodArr[$qm]))\r
- {\r
- $r['querymodules'][] = array('name' => $qm, 'missing' => '');\r
- continue;\r
- }\r
- $obj = new $qmodArr[$qm]($this, $qm);\r
- $a = $this->getClassInfo($obj);\r
- $a['name'] = $qm;\r
- $r['querymodules'][] = $a;\r
- }\r
- $result->setIndexedTagName($r['querymodules'], 'module');\r
- }\r
- $result->addValue(null, $this->getModuleName(), $r);\r
- }\r
-\r
- function getClassInfo($obj)\r
- {\r
- $result = $this->getResult();\r
- $retval['classname'] = get_class($obj);\r
- $retval['description'] = (is_array($obj->getDescription()) ? implode("\n", $obj->getDescription()) : $obj->getDescription());\r
- $retval['prefix'] = $obj->getModulePrefix();\r
- $allowedParams = $obj->getAllowedParams();\r
- 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
- if(!is_array($p))\r
- {\r
- if(is_bool($p))\r
- {\r
- $a['type'] = 'bool';\r
- $a['default'] = ($p ? 'true' : 'false');\r
- }\r
- if(is_string($p))\r
- $a['default'] = $p;\r
- $retval['parameters'][] = $a;\r
- continue;\r
- }\r
- \r
- if(isset($p[ApiBase::PARAM_DFLT]))\r
- $a['default'] = $p[ApiBase::PARAM_DFLT];\r
- if(isset($p[ApiBase::PARAM_ISMULTI]))\r
- if($p[ApiBase::PARAM_ISMULTI])\r
- $a['multi'] = '';\r
- if(isset($p[ApiBase::PARAM_TYPE]))\r
- {\r
- $a['type'] = $p[ApiBase::PARAM_TYPE];\r
- if(is_array($a['type']))\r
- $result->setIndexedTagName($a['type'], 't');\r
- }\r
- if(isset($p[ApiBase::PARAM_MAX]))\r
- $a['max'] = $p[ApiBase::PARAM_MAX];\r
- if(isset($p[ApiBase::PARAM_MAX2]))\r
- $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
- return $retval;\r
- }\r
- \r
- protected function getAllowedParams() {\r
- return array (\r
- 'modules' => array(\r
- ApiBase :: PARAM_ISMULTI => true\r
- ),\r
- 'querymodules' => array(\r
- ApiBase :: PARAM_ISMULTI => true\r
- )\r
- );\r
- }\r
-\r
- protected function getParamDescription() {\r
- return array (\r
- 'modules' => 'List of module names (value of the action= parameter)',\r
- 'querymodules' => 'List of query module names (value of prop=, meta= or list= parameter)',\r
- );\r
- }\r
-\r
- protected function getDescription() {\r
- return 'Obtain information about certain API parameters';\r
- }\r
-\r
- protected function getExamples() {\r
- return array (\r
- 'api.php?action=paraminfo&modules=parse&querymodules=allpages|siteinfo'\r
- );\r
- }\r
-\r
- public function getVersion() {\r
- return __CLASS__ . ': $Id: ApiParse.php 29810 2008-01-15 21:33:08Z catrope $';\r
- }\r
-}\r
-\r
+<?php
+/**
+ * API for MediaWiki 1.8+
+ *
+ * Created on Dec 01, 2007
+ *
+ * Copyright © 2008 Roan Kattouw <Firstname>.<Lastname>@home.nl
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
+
+if ( !defined( 'MEDIAWIKI' ) ) {
+ // Eclipse helper - will be ignored in production
+ require_once( "ApiBase.php" );
+}
+
+/**
+ * @ingroup API
+ */
+class ApiParamInfo extends ApiBase {
+
+ public function __construct( $main, $action ) {
+ parent::__construct( $main, $action );
+ }
+
+ public function execute() {
+ // Get parameters
+ $params = $this->extractRequestParams();
+ $result = $this->getResult();
+ $queryObj = new ApiQuery( $this->getMain(), 'query' );
+ $r = array();
+ if ( is_array( $params['modules'] ) ) {
+ $modArr = $this->getMain()->getModules();
+ $r['modules'] = array();
+ foreach ( $params['modules'] as $m ) {
+ if ( !isset( $modArr[$m] ) ) {
+ $r['modules'][] = array( 'name' => $m, 'missing' => '' );
+ continue;
+ }
+ $obj = new $modArr[$m]( $this->getMain(), $m );
+ $a = $this->getClassInfo( $obj );
+ $a['name'] = $m;
+ $r['modules'][] = $a;
+ }
+ $result->setIndexedTagName( $r['modules'], 'module' );
+ }
+ if ( is_array( $params['querymodules'] ) ) {
+ $qmodArr = $queryObj->getModules();
+ $r['querymodules'] = array();
+ foreach ( $params['querymodules'] as $qm ) {
+ if ( !isset( $qmodArr[$qm] ) ) {
+ $r['querymodules'][] = array( 'name' => $qm, 'missing' => '' );
+ continue;
+ }
+ $obj = new $qmodArr[$qm]( $this, $qm );
+ $a = $this->getClassInfo( $obj );
+ $a['name'] = $qm;
+ $r['querymodules'][] = $a;
+ }
+ $result->setIndexedTagName( $r['querymodules'], 'module' );
+ }
+ if ( $params['mainmodule'] ) {
+ $r['mainmodule'] = $this->getClassInfo( $this->getMain() );
+ }
+ if ( $params['pagesetmodule'] ) {
+ $pageSet = new ApiPageSet( $queryObj );
+ $r['pagesetmodule'] = $this->getClassInfo( $pageSet );
+ }
+ $result->addValue( null, $this->getModuleName(), $r );
+ }
+
+ function getClassInfo( $obj ) {
+ $result = $this->getResult();
+ $retval['classname'] = get_class( $obj );
+ $retval['description'] = implode( "\n", (array)$obj->getDescription() );
+ $retval['version'] = implode( "\n", (array)$obj->getVersion() );
+ $retval['prefix'] = $obj->getModulePrefix();
+
+ if ( $obj->isReadMode() ) {
+ $retval['readrights'] = '';
+ }
+ if ( $obj->isWriteMode() ) {
+ $retval['writerights'] = '';
+ }
+ if ( $obj->mustBePosted() ) {
+ $retval['mustbeposted'] = '';
+ }
+ if ( $obj instanceof ApiQueryGeneratorBase ) {
+ $retval['generator'] = '';
+ }
+
+ $allowedParams = $obj->getFinalParams();
+ if ( !is_array( $allowedParams ) ) {
+ return $retval;
+ }
+
+ $retval['parameters'] = array();
+ $paramDesc = $obj->getFinalParamDescription();
+ foreach ( $allowedParams as $n => $p ) {
+ $a = array( 'name' => $n );
+ if ( isset( $paramDesc[$n] ) ) {
+ $a['description'] = implode( "\n", (array)$paramDesc[$n] );
+ }
+ if ( isset( $p[ApiBase::PARAM_DEPRECATED] ) && $p[ApiBase::PARAM_DEPRECATED] ) {
+ $a['deprecated'] = '';
+ }
+ if ( isset( $p[ApiBase::PARAM_REQUIRED] ) && $p[ApiBase::PARAM_REQUIRED] ) {
+ $a['required'] = '';
+ }
+
+ if ( !is_array( $p ) ) {
+ if ( is_bool( $p ) ) {
+ $a['type'] = 'bool';
+ $a['default'] = ( $p ? 'true' : 'false' );
+ } elseif ( is_string( $p ) || is_null( $p ) ) {
+ $a['type'] = 'string';
+ $a['default'] = strval( $p );
+ } elseif ( is_int( $p ) ) {
+ $a['type'] = 'integer';
+ $a['default'] = intval( $p );
+ }
+ $retval['parameters'][] = $a;
+ continue;
+ }
+
+ if ( isset( $p[ApiBase::PARAM_DFLT] ) ) {
+ $a['default'] = $p[ApiBase::PARAM_DFLT];
+ }
+ if ( isset( $p[ApiBase::PARAM_ISMULTI] ) && $p[ApiBase::PARAM_ISMULTI] ) {
+ $a['multi'] = '';
+ $a['limit'] = $this->getMain()->canApiHighLimits() ?
+ ApiBase::LIMIT_SML2 :
+ ApiBase::LIMIT_SML1;
+ }
+
+ if ( isset( $p[ApiBase::PARAM_ALLOW_DUPLICATES] ) && $p[ApiBase::PARAM_ALLOW_DUPLICATES] ) {
+ $a['allowsduplicates'] = '';
+ }
+
+ if ( isset( $p[ApiBase::PARAM_TYPE] ) ) {
+ $a['type'] = $p[ApiBase::PARAM_TYPE];
+ if ( is_array( $a['type'] ) ) {
+ $result->setIndexedTagName( $a['type'], 't' );
+ }
+ }
+ if ( isset( $p[ApiBase::PARAM_MAX] ) ) {
+ $a['max'] = $p[ApiBase::PARAM_MAX];
+ }
+ if ( isset( $p[ApiBase::PARAM_MAX2] ) ) {
+ $a['highmax'] = $p[ApiBase::PARAM_MAX2];
+ }
+ if ( isset( $p[ApiBase::PARAM_MIN] ) ) {
+ $a['min'] = $p[ApiBase::PARAM_MIN];
+ }
+ $retval['parameters'][] = $a;
+ }
+ $result->setIndexedTagName( $retval['parameters'], 'param' );
+
+ // Errors
+ $retval['errors'] = $this->parseErrors( $obj->getPossibleErrors() );
+
+ $result->setIndexedTagName( $retval['errors'], 'error' );
+
+ return $retval;
+ }
+
+ public function isReadMode() {
+ return false;
+ }
+
+ public function getAllowedParams() {
+ return array(
+ 'modules' => array(
+ ApiBase::PARAM_ISMULTI => true
+ ),
+ 'querymodules' => array(
+ ApiBase::PARAM_ISMULTI => true
+ ),
+ 'mainmodule' => false,
+ 'pagesetmodule' => false,
+ );
+ }
+
+ public function getParamDescription() {
+ return array(
+ 'modules' => 'List of module names (value of the action= parameter)',
+ 'querymodules' => 'List of query module names (value of prop=, meta= or list= parameter)',
+ 'mainmodule' => 'Get information about the main (top-level) module as well',
+ 'pagesetmodule' => 'Get information about the pageset module (providing titles= and friends) as well',
+ );
+ }
+
+ public function getDescription() {
+ return 'Obtain information about certain API parameters and errors';
+ }
+
+ protected function getExamples() {
+ return array(
+ 'api.php?action=paraminfo&modules=parse&querymodules=allpages|siteinfo'
+ );
+ }
+
+ public function getVersion() {
+ return __CLASS__ . ': $Id$';
+ }
+}
dépôts / lhc / web / wiklou.git / blobdiff