X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2Fapi%2FApiHelp.php;h=d94132a59d9498c3ba60bda8de56e138fd8620d4;hb=53f96171cccb378824f8708c3fe41cfb0fcdd62e;hp=80c96d6e2f4e818a6d293e16d3d838ed7103bee2;hpb=e7ad7f3d41618b908e806251d9efb64e1e6008d9;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/api/ApiHelp.php b/includes/api/ApiHelp.php index 80c96d6e2f..d94132a59d 100644 --- a/includes/api/ApiHelp.php +++ b/includes/api/ApiHelp.php @@ -1,48 +1,163 @@ - - * - * 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., - * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - * http://www.gnu.org/copyleft/gpl.html - */ - -if (!defined('MEDIAWIKI')) { - // Eclipse helper - will be ignored in production - require_once ("ApiBase.php"); -} - -class ApiHelp extends ApiBase { - - /** - * Constructor - */ - public function __construct($main, $action) { - parent :: __construct($main); - } - - /** - * Stub module for displaying help when no parameters are given - */ - public function Execute() { - $this->DieUsage('', 'help'); - } -} -?> \ No newline at end of file +@gmail.com + * + * 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 + */ + +/** + * This is a simple class to handle action=help + * + * @ingroup API + */ +class ApiHelp extends ApiBase { + + public function __construct( $main, $action ) { + parent::__construct( $main, $action ); + } + + /** + * Module for displaying help + */ + public function execute() { + // Get parameters + $params = $this->extractRequestParams(); + + if ( !isset( $params['modules'] ) && !isset( $params['querymodules'] ) ) { + $this->dieUsage( '', 'help' ); + } + + $this->getMain()->setHelp(); + + $result = $this->getResult(); + $queryObj = new ApiQuery( $this->getMain(), 'query' ); + $r = array(); + if ( is_array( $params['modules'] ) ) { + $modArr = $this->getMain()->getModules(); + + foreach ( $params['modules'] as $m ) { + if ( !isset( $modArr[$m] ) ) { + $r[] = array( 'name' => $m, 'missing' => '' ); + continue; + } + $module = new $modArr[$m]( $this->getMain(), $m ); + + $r[] = $this->buildModuleHelp( $module, 'action' ); + } + } + + if ( is_array( $params['querymodules'] ) ) { + $qmodArr = $queryObj->getModules(); + + foreach ( $params['querymodules'] as $qm ) { + if ( !isset( $qmodArr[$qm] ) ) { + $r[] = array( 'name' => $qm, 'missing' => '' ); + continue; + } + $module = new $qmodArr[$qm]( $this, $qm ); + $type = $queryObj->getModuleType( $qm ); + + if ( $type === null ) { + $r[] = array( 'name' => $qm, 'missing' => '' ); + continue; + } + + $r[] = $this->buildModuleHelp( $module, $type ); + } + } + $result->setIndexedTagName( $r, 'module' ); + $result->addValue( null, $this->getModuleName(), $r ); + } + + /** + * @param $module ApiBase + * @param $type String What type of request is this? e.g. action, query, list, prop, meta, format + * @return string + */ + private function buildModuleHelp( $module, $type ) { + $msg = ApiMain::makeHelpMsgHeader( $module, $type ); + + $msg2 = $module->makeHelpMsg(); + if ( $msg2 !== false ) { + $msg .= $msg2; + } + + return $msg; + } + + public function shouldCheckMaxlag() { + return false; + } + + public function isReadMode() { + return false; + } + + public function getAllowedParams() { + return array( + 'modules' => array( + ApiBase::PARAM_ISMULTI => true + ), + 'querymodules' => array( + ApiBase::PARAM_ISMULTI => true + ), + ); + } + + 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)', + ); + } + + public function getDescription() { + return 'Display this help screen. Or the help screen for the specified module'; + } + + public function getExamples() { + return array( + 'Whole help page:', + ' api.php?action=help', + 'Module (action) help page:', + ' api.php?action=help&modules=protect', + 'Query (list) modules help page:', + ' api.php?action=help&querymodules=categorymembers', + 'Query (prop) modules help page:', + ' api.php?action=help&querymodules=info', + 'Query (meta) modules help page:', + ' api.php?action=help&querymodules=siteinfo', + ); + } + + public function getHelpUrls() { + return array( + 'https://www.mediawiki.org/wiki/API:Main_page', + 'https://www.mediawiki.org/wiki/API:FAQ', + 'https://www.mediawiki.org/wiki/API:Quick_start_guide', + ); + } + + public function getVersion() { + return __CLASS__ . ': $Id$'; + } +}