SearchResultSet.php

Go to the documentation of this file.

<?php
class SearchResultSet {
    function termMatches() {
        return array();
    }

    function numRows() {
        return 0;
    }

    function getTotalHits() {
        return null;
    }

    function hasSuggestion() {
        return false;
    }

    function getSuggestionQuery() {
        return null;
    }

    function getSuggestionSnippet() {
        return '';
    }

    function getInterwikiResults() {
        return null;
    }

    function hasInterwikiResults() {
        return $this->getInterwikiResults() != null;
    }

    function next() {
        return false;
    }

    function free() {
        // ...
    }

    public function searchContainedSyntax() {
        return false;
    }
}

class SqlSearchResultSet extends SearchResultSet {
    protected $resultSet;
    protected $terms;
    protected $totalHits;

    function __construct( $resultSet, $terms, $total = null ) {
        $this->resultSet = $resultSet;
        $this->terms = $terms;
        $this->totalHits = $total;
    }

    function termMatches() {
        return $this->terms;
    }

    function numRows() {
        if ( $this->resultSet === false ) {
            return false;
        }

        return $this->resultSet->numRows();
    }

    function next() {
        if ( $this->resultSet === false ) {
            return false;
        }

        $row = $this->resultSet->fetchObject();
        if ( $row === false ) {
            return false;
        }

        return SearchResult::newFromTitle(
            Title::makeTitle( $row->page_namespace, $row->page_title )
        );
    }

    function free() {
        if ( $this->resultSet === false ) {
            return false;
        }

        $this->resultSet->free();
    }

    function getTotalHits() {
        if ( !is_null( $this->totalHits ) ) {
            return $this->totalHits;
        } else {
            // Special:Search expects a number here.
            return $this->numRows();
        }
    }
}

class SearchNearMatchResultSet extends SearchResultSet {
    private $fetched = false;

    public function __construct( $match ) {
        $this->result = $match;
    }

    public function numRows() {
        return $this->result ? 1 : 0;
    }

    public function next() {
        if ( $this->fetched || !$this->result ) {
            return false;
        }
        $this->fetched = true;
        return SearchResult::newFromTitle( $this->result );
    }
}