ApiQueryPrefixSearch.php

Go to the documentation of this file.

<?php
class ApiQueryPrefixSearch extends ApiQueryGeneratorBase {
    public function __construct( $query, $moduleName ) {
        parent::__construct( $query, $moduleName, 'ps' );
    }

    public function execute() {
        $this->run();
    }

    public function executeGenerator( $resultPageSet ) {
        $this->run( $resultPageSet );
    }

    private function run( $resultPageSet = null ) {
        $params = $this->extractRequestParams();
        $search = $params['search'];
        $limit = $params['limit'];
        $namespaces = $params['namespace'];

        $searcher = new TitlePrefixSearch;
        $titles = $searcher->searchWithVariants( $search, $limit, $namespaces );
        if ( $resultPageSet ) {
            $resultPageSet->populateFromTitles( $titles );
        } else {
            $result = $this->getResult();
            foreach ( $titles as $title ) {
                if ( !$limit-- ) {
                    break;
                }
                $vals = array(
                    'ns' => intval( $title->getNamespace() ),
                    'title' => $title->getPrefixedText(),
                );
                if ( $title->isSpecialPage() ) {
                    $vals['special'] = '';
                } else {
                    $vals['pageid'] = intval( $title->getArticleId() );
                }
                $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $vals );
                if ( !$fit ) {
                    break;
                }
            }
            $result->setIndexedTagName_internal(
                array( 'query', $this->getModuleName() ), $this->getModulePrefix()
            );
        }
    }

    public function getCacheMode( $params ) {
        return 'public';
    }

    public function getAllowedParams() {
            return array(
                'search' => array(
                    ApiBase::PARAM_TYPE => 'string',
                    ApiBase::PARAM_REQUIRED => true,
                ),
                'namespace' => array(
                    ApiBase::PARAM_DFLT => NS_MAIN,
                    ApiBase::PARAM_TYPE => 'namespace',
                    ApiBase::PARAM_ISMULTI => true,
                ),
                'limit' => array(
                    ApiBase::PARAM_DFLT => 10,
                    ApiBase::PARAM_TYPE => 'limit',
                    ApiBase::PARAM_MIN => 1,
                    // Non-standard value for compatibility with action=opensearch
                    ApiBase::PARAM_MAX => 100,
                    ApiBase::PARAM_MAX2 => 200,
                ),
            );
    }

    public function getParamDescription() {
        return array(
            'search' => 'Search string',
            'limit' => 'Maximum amount of results to return',
            'namespace' => 'Namespaces to search',
        );
    }

    public function getDescription() {
        return 'Perform a prefix search for page titles';
    }

    public function getExamples() {
        return array(
            'api.php?action=query&list=prefixsearch&pssearch=meaning',
        );
    }

    public function getHelpUrls() {
        return 'https://www.mediawiki.org/wiki/API:Prefixsearch';
    }
}