ISearchResultSet.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Search;
 
use MediaWiki\Title\Title;
use Wikimedia\HtmlArmor\HtmlArmor;
 
interface ISearchResultSet extends \Countable, \IteratorAggregate {
    public const SECONDARY_RESULTS = 0;
 
    public const INLINE_RESULTS = 1;
 
    public function numRows();
 
    public function getTotalHits();
 
    public function isApproximateTotalHits(): bool;
 
    public function hasRewrittenQuery();
 
    public function getQueryAfterRewrite();
 
    public function getQueryAfterRewriteSnippet();
 
    public function hasSuggestion();
 
    public function getSuggestionQuery();
 
    public function getSuggestionSnippet();
 
    public function getInterwikiResults( $type = self::SECONDARY_RESULTS );
 
    public function hasInterwikiResults( $type = self::SECONDARY_RESULTS );
 
    public function searchContainedSyntax();
 
    public function hasMoreResults();
 
    public function shrink( $limit );
 
    public function extractResults();
 
    public function extractTitles();
 
    public function setAugmentedData( $name, $data );
 
    public function augmentResult( SearchResult $result );
 
    public function getOffset();
}
 
class_alias( ISearchResultSet::class, 'ISearchResultSet' );