SearchResultSet.php

Go to the documentation of this file.

<?php
class SearchResultSet extends BaseSearchResultSet {
    use SearchResultSetTrait;
 
    protected $containedSyntax = false;
 
    private $titles;
 
    protected $results;
 
    private $hasMoreResults;
 
    public function __construct( $containedSyntax = false, $hasMoreResults = false ) {
        if ( static::class === self::class ) {
            // This class will eventually be abstract. SearchEngine implementations
            // already have to extend this class anyways to provide the actual
            // search results.
            wfDeprecated( __METHOD__, '1.32' );
        }
        $this->containedSyntax = $containedSyntax;
        $this->hasMoreResults = $hasMoreResults;
    }
 
    public function numRows() {
        return $this->count();
    }
 
    final public function count() {
        return count( $this->extractResults() );
    }
 
    public function getTotalHits() {
        return null;
    }
 
    public function hasRewrittenQuery() {
        return false;
    }
 
    public function getQueryAfterRewrite() {
        return null;
    }
 
    public function getQueryAfterRewriteSnippet() {
        return null;
    }
 
    public function hasSuggestion() {
        return false;
    }
 
    public function getSuggestionQuery() {
        return null;
    }
 
    public function getSuggestionSnippet() {
        return '';
    }
 
    public function getInterwikiResults( $type = self::SECONDARY_RESULTS ) {
        return null;
    }
 
    public function hasInterwikiResults( $type = self::SECONDARY_RESULTS ) {
        return false;
    }
 
    public function searchContainedSyntax() {
        return $this->containedSyntax;
    }
 
    public function hasMoreResults() {
        return $this->hasMoreResults;
    }
 
    public function shrink( $limit ) {
        if ( $this->count() > $limit ) {
            $this->hasMoreResults = true;
            // shrinking result set for implementations that
            // have not implemented extractResults and use
            // the default cache location. Other implementations
            // must override this as well.
            if ( is_array( $this->results ) ) {
                $this->results = array_slice( $this->results, 0, $limit );
            } else {
                throw new \UnexpectedValueException(
                    "When overriding result store extending classes must "
                    . " also override " . __METHOD__ );
            }
        }
    }
 
    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;
    }
}