SearchResultSet.php

Go to the documentation of this file.

<?php
class SearchResultSet {

    const SECONDARY_RESULTS = 0;
    const INLINE_RESULTS = 1;

    protected $containedSyntax = false;

    private $titles;

    private $results;

    protected $extraData = [];

    public function __construct( $containedSyntax = false ) {
        $this->containedSyntax = $containedSyntax;
    }

    function termMatches() {
        return [];
    }

    function numRows() {
        return 0;
    }

    function getTotalHits() {
        return null;
    }

    function hasRewrittenQuery() {
        return false;
    }

    function getQueryAfterRewrite() {
        return null;
    }

    function getQueryAfterRewriteSnippet() {
        return null;
    }

    function hasSuggestion() {
        return false;
    }

    function getSuggestionQuery() {
        return null;
    }

    function getSuggestionSnippet() {
        return '';
    }

    function getInterwikiResults( $type = self::SECONDARY_RESULTS ) {
        return null;
    }

    function hasInterwikiResults( $type = self::SECONDARY_RESULTS ) {
        return false;
    }

    function next() {
        return false;
    }

    function rewind() {
    }

    function free() {
        // ...
    }

    public function searchContainedSyntax() {
        return $this->containedSyntax;
    }

    public function extractResults() {
        if ( is_null( $this->results ) ) {
            $this->results = [];
            if ( $this->numRows() == 0 ) {
                // Don't bother if we've got empty result
                return $this->results;
            }
            $this->rewind();
            while ( ( $result = $this->next() ) != false ) {
                $this->results[] = $result;
            }
            $this->rewind();
        }
        return $this->results;
    }

    public function extractTitles() {
        if ( is_null( $this->titles ) ) {
            if ( $this->numRows() == 0 ) {
                // Don't bother if we've got empty result
                $this->titles = [];
            } else {
                $this->titles = array_map(
                    function ( SearchResult $result ) {
                        return $result->getTitle();
                    },
                    $this->extractResults() );
            }
        }
        return $this->titles;
    }

    public function setAugmentedData( $name, $data ) {
        foreach ( $data as $id => $resultData ) {
            $this->extraData[$id][$name] = $resultData;
        }
    }

    public function augmentResult( SearchResult $result ) {
        $id = $result->getTitle()->getArticleID();
        if ( !$id || !isset( $this->extraData[$id] ) ) {
            return null;
        }
        $result->setExtensionData( $this->extraData[$id] );
        return $this->extraData[$id];
    }
}