ApiOpenSearch.php

Go to the documentation of this file.

<?php
class ApiOpenSearch extends ApiBase {

    public function getCustomPrinter() {
        $params = $this->extractRequestParams();
        $format = $params['format'];
        $allowed = array( 'json', 'jsonfm' );
        if ( in_array( $format, $allowed ) ) {
            return $this->getMain()->createPrinterByName( $format );
        }

        return $this->getMain()->createPrinterByName( $allowed[0] );
    }

    public function execute() {
        $params = $this->extractRequestParams();
        $search = $params['search'];
        $limit = $params['limit'];
        $namespaces = $params['namespace'];
        $suggest = $params['suggest'];

        // Some script that was loaded regardless of wgEnableOpenSearchSuggest, likely cached.
        if ( $suggest && !$this->getConfig()->get( 'EnableOpenSearchSuggest' ) ) {
            $searches = array();
        } else {
            // Open search results may be stored for a very long time
            $this->getMain()->setCacheMaxAge( $this->getConfig()->get( 'SearchSuggestCacheExpiry' ) );
            $this->getMain()->setCacheMode( 'public' );

            $searcher = new StringPrefixSearch;
            $searches = $searcher->searchWithVariants( $search, $limit, $namespaces );
        }
        // Set top level elements
        $result = $this->getResult();
        $result->addValue( null, 0, $search );
        $result->addValue( null, 1, $searches );
    }

    public function getAllowedParams() {
        return array(
            'search' => null,
            'limit' => array(
                ApiBase::PARAM_DFLT => $this->getConfig()->get( 'OpenSearchDefaultLimit' ),
                ApiBase::PARAM_TYPE => 'limit',
                ApiBase::PARAM_MIN => 1,
                ApiBase::PARAM_MAX => 100,
                ApiBase::PARAM_MAX2 => 100
            ),
            'namespace' => array(
                ApiBase::PARAM_DFLT => NS_MAIN,
                ApiBase::PARAM_TYPE => 'namespace',
                ApiBase::PARAM_ISMULTI => true
            ),
            'suggest' => false,
            'format' => array(
                ApiBase::PARAM_DFLT => 'json',
                ApiBase::PARAM_TYPE => array( 'json', 'jsonfm' ),
            )
        );
    }

    public function getParamDescription() {
        return array(
            'search' => 'Search string',
            'limit' => 'Maximum amount of results to return',
            'namespace' => 'Namespaces to search',
            'suggest' => 'Do nothing if $wgEnableOpenSearchSuggest is false',
            'format' => 'The format of the output',
        );
    }

    public function getDescription() {
        return 'Search the wiki using the OpenSearch protocol.';
    }

    public function getExamples() {
        return array(
            'api.php?action=opensearch&search=Te'
        );
    }

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