ApiQueryPrefixSearch.php

Go to the documentation of this file.

<?php
 
class ApiQueryPrefixSearch extends ApiQueryGeneratorBase {
    use SearchApi;
 
    private $allowedParams;
 
    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'];
        $offset = $params['offset'];
 
        $searchEngine = $this->buildSearchEngine( $params );
        $titles = $searchEngine->extractTitles( $searchEngine->completionSearchWithVariants( $search ) );
 
        if ( $resultPageSet ) {
            $resultPageSet->setRedirectMergePolicy( function ( array $current, array $new ) {
                if ( !isset( $current['index'] ) || $new['index'] < $current['index'] ) {
                    $current['index'] = $new['index'];
                }
                return $current;
            } );
            if ( count( $titles ) > $limit ) {
                $this->setContinueEnumParameter( 'offset', $offset + $limit );
                array_pop( $titles );
            }
            $resultPageSet->populateFromTitles( $titles );
            foreach ( $titles as $index => $title ) {
                $resultPageSet->setGeneratorData( $title, [ 'index' => $index + $offset + 1 ] );
            }
        } else {
            $result = $this->getResult();
            $count = 0;
            foreach ( $titles as $title ) {
                if ( ++$count > $limit ) {
                    $this->setContinueEnumParameter( 'offset', $offset + $limit );
                    break;
                }
                $vals = [
                    'ns' => intval( $title->getNamespace() ),
                    'title' => $title->getPrefixedText(),
                ];
                if ( $title->isSpecialPage() ) {
                    $vals['special'] = true;
                } else {
                    $vals['pageid'] = intval( $title->getArticleID() );
                }
                $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $vals );
                if ( !$fit ) {
                    $this->setContinueEnumParameter( 'offset', $offset + $count - 1 );
                    break;
                }
            }
            $result->addIndexedTagName(
                [ 'query', $this->getModuleName() ], $this->getModulePrefix()
            );
        }
    }
 
    public function getCacheMode( $params ) {
        return 'public';
    }
 
    public function getAllowedParams() {
        if ( $this->allowedParams !== null ) {
            return $this->allowedParams;
        }
        $this->allowedParams = $this->buildCommonApiParams();
 
        return $this->allowedParams;
    }
 
    public function getSearchProfileParams() {
        return [
            'profile' => [
                'profile-type' => SearchEngine::COMPLETION_PROFILE_TYPE,
                'help-message' => 'apihelp-query+prefixsearch-param-profile',
            ],
        ];
    }
 
    protected function getExamplesMessages() {
        return [
            'action=query&list=prefixsearch&pssearch=meaning'
                => 'apihelp-query+prefixsearch-example-simple',
        ];
    }
 
    public function getHelpUrls() {
        return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Prefixsearch';
    }
}