BlueSpice MediaWiki REL1_27
 All Classes Namespaces Files Functions Variables Groups Pages
SearchResultSet Class Reference
Inheritance diagram for SearchResultSet:

Public Member Functions

 __construct ($containedSyntax=false)
 
 termMatches ()
 
 numRows ()
 
 getTotalHits ()
 
 hasRewrittenQuery ()
 
 getQueryAfterRewrite ()
 
 getQueryAfterRewriteSnippet ()
 
 hasSuggestion ()
 
 getSuggestionQuery ()
 
 getSuggestionSnippet ()
 
 getInterwikiResults ($type=self::SECONDARY_RESULTS)
 
 hasInterwikiResults ($type=self::SECONDARY_RESULTS)
 
 next ()
 
 rewind ()
 
 free ()
 
 searchContainedSyntax ()
 

Public Attributes

const SECONDARY_RESULTS = 0
 
const INLINE_RESULTS = 1
 

Protected Attributes

 $containedSyntax = false
 

Member Function Documentation

SearchResultSet::free ( )

Frees the result set, if applicable.

SearchResultSet::getInterwikiResults (   $type = self::SECONDARY_RESULTS)

Return a result set of hits on other (multiple) wikis associated with this one

Returns
SearchResultSet[]
SearchResultSet::getQueryAfterRewrite ( )
Returns
string|null The search the query was internally rewritten to, or null when the result of the original query was returned.
SearchResultSet::getQueryAfterRewriteSnippet ( )
Returns
string|null Same as self::getQueryAfterRewrite(), but in HTML and with changes highlighted. Null when the query was not rewritten.
SearchResultSet::getSuggestionQuery ( )
Returns
string|null Suggested query, null if none
SearchResultSet::getSuggestionSnippet ( )
Returns
string HTML highlighted suggested query, '' if none
SearchResultSet::getTotalHits ( )

Some search modes return a total hit count for the query in the entire article database. This may include pages in namespaces that would not be matched on the given settings.

Return null if no total hits number is supported.

Returns
int
SearchResultSet::hasInterwikiResults (   $type = self::SECONDARY_RESULTS)

Check if there are results on other wikis

Returns
bool
SearchResultSet::hasRewrittenQuery ( )

Some search modes will run an alternative query that it thinks gives a better result than the provided search. Returns true if this has occured.

Returns
bool
SearchResultSet::hasSuggestion ( )

Some search modes return a suggested alternate term if there are no exact hits. Returns true if there is one on this set.

Returns
bool
SearchResultSet::next ( )

Fetches next search result, or false. STUB

Returns
SearchResult
SearchResultSet::rewind ( )

Rewind result set back to begining

SearchResultSet::searchContainedSyntax ( )

Did the search contain search syntax? If so, Special:Search won't offer the user a link to a create a page named by the search string because the name would contain the search syntax.

Returns
bool
SearchResultSet::termMatches ( )

Fetch an array of regular expression fragments for matching the search terms as parsed by this engine in a text extract. STUB

Returns
array

The documentation for this class was generated from the following file: