ApiHelp.php

Go to the documentation of this file.

<?php
class ApiHelp extends ApiBase {

    public function execute() {
        // Get parameters
        $params = $this->extractRequestParams();

        if ( !isset( $params['modules'] ) && !isset( $params['querymodules'] ) ) {
            $this->dieUsage( '', 'help' );
        }

        $this->getMain()->setHelp();
        $result = $this->getResult();

        if ( is_array( $params['modules'] ) ) {
            $modules = $params['modules'];
        } else {
            $modules = array();
        }

        if ( is_array( $params['querymodules'] ) ) {
            $queryModules = $params['querymodules'];
            foreach ( $queryModules as $m ) {
                $modules[] = 'query+' . $m;
            }
        } else {
            $queryModules = array();
        }

        $r = array();
        foreach ( $modules as $m ) {
            // sub-modules could be given in the form of "name[+name[+name...]]"
            $subNames = explode( '+', $m );
            if ( count( $subNames ) === 1 ) {
                // In case the '+' was typed into URL, it resolves as a space
                $subNames = explode( ' ', $m );
            }
            $module = $this->getMain();
            for ( $i = 0; $i < count( $subNames ); $i++ ) {
                $subs = $module->getModuleManager();
                if ( $subs === null ) {
                    $module = null;
                } else {
                    $module = $subs->getModule( $subNames[$i] );
                }
                if ( $module === null ) {
                    if ( count( $subNames ) === 2
                            && $i === 1
                            && $subNames[0] === 'query'
                            && in_array( $subNames[1], $queryModules )
                    ) {
                        // Legacy: This is one of the renamed 'querymodule=...' parameters,
                        // do not use '+' notation in the output, use submodule's name instead.
                        $name = $subNames[1];
                    } else {
                        $name = implode( '+', array_slice( $subNames, 0, $i + 1 ) );
                    }
                    $r[] = array( 'name' => $name, 'missing' => '' );
                    break;
                } else {
                    $type = $subs->getModuleGroup( $subNames[$i] );
                }
            }
            if ( $module !== null ) {
                $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,
                ApiBase::PARAM_DEPRECATED => true
            ),
        );
    }

    public function getParamDescription() {
        return array(
            'modules' => 'List of module names (value of the action= parameter). Can specify submodules with a \'+\'',
            'querymodules' => 'Use modules=query+value instead. 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&modules=query+categorymembers' => 'Help for the query/categorymembers module',
            'api.php?action=help&modules=login|query+info' => 'Help for the login and query/info modules',
        );
    }

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