ApiHelp.php

Go to the documentation of this file.

<?php
class ApiHelp extends ApiBase {

        public function __construct( $main, $action ) {
                parent::__construct( $main, $action );
        }

        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 );
        }

        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(
                        'api.php?action=help' => 'Whole help page',
                        'api.php?action=help&modules=protect' => 'Module (action) help page',
                        'api.php?action=help&querymodules=categorymembers' => 'Query (list) modules help page',
                        'api.php?action=help&querymodules=info' => 'Query (prop) modules help page',
                        'api.php?action=help&querymodules=siteinfo' => 'Query (meta) modules help page',
                );
        }

        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$';
        }
}