SearchResultSet Class Reference
[Search]

Inherited by SqlSearchResultSet.

List of all members.

Public Member Functions

 termMatches ()
 Fetch an array of regular expression fragments for matching the search terms as parsed by this engine in a text extract.
 numRows ()
 hasResults ()
 Return true if results are included in this result set.
 getTotalHits ()
 Some search modes return a total hit count for the query in the entire article database.
 hasSuggestion ()
 Some search modes return a suggested alternate term if there are no exact hits.
 getSuggestionQuery ()
 getSuggestionSnippet ()
 getInfo ()
 Return information about how and from where the results were fetched, should be useful for diagnostics and debugging.
 getInterwikiResults ()
 Return a result set of hits on other (multiple) wikis associated with this one.
 hasInterwikiResults ()
 Check if there are results on other wikis.
 next ()
 Fetches next search result, or false.
 free ()
 Frees the result set, if applicable.


Detailed Description

Definition at line 436 of file SearchEngine.php.


Member Function Documentation

SearchResultSet::free (  ) 

Frees the result set, if applicable.

Reimplemented in SqlSearchResultSet.

Definition at line 542 of file SearchEngine.php.

SearchResultSet::getInfo (  ) 

Return information about how and from where the results were fetched, should be useful for diagnostics and debugging.

Returns:
String

Definition at line 506 of file SearchEngine.php.

SearchResultSet::getInterwikiResults (  ) 

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

Returns:
SearchResultSet

Definition at line 515 of file SearchEngine.php.

Referenced by hasInterwikiResults().

SearchResultSet::getSuggestionQuery (  ) 

Returns:
String: suggested query, null if none

Definition at line 489 of file SearchEngine.php.

SearchResultSet::getSuggestionSnippet (  ) 

Returns:
String: HTML highlighted suggested query, '' if none

Definition at line 496 of file SearchEngine.php.

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:
Integer

Reimplemented in MySQLSearchResultSet, and SqliteSearchResultSet.

Definition at line 472 of file SearchEngine.php.

SearchResultSet::hasInterwikiResults (  ) 

Check if there are results on other wikis.

Returns:
Boolean

Definition at line 524 of file SearchEngine.php.

References getInterwikiResults().

SearchResultSet::hasResults (  ) 

Return true if results are included in this result set.

STUB

Returns:
Boolean

Definition at line 458 of file SearchEngine.php.

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:
Boolean

Definition at line 482 of file SearchEngine.php.

SearchResultSet::next (  ) 

Fetches next search result, or false.

STUB

Returns:
SearchResult

Reimplemented in SqlSearchResultSet, and PostgresSearchResultSet.

Definition at line 535 of file SearchEngine.php.

SearchResultSet::numRows (  ) 

Reimplemented in SqlSearchResultSet.

Definition at line 448 of file SearchEngine.php.

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

Reimplemented in SqlSearchResultSet.

Definition at line 444 of file SearchEngine.php.


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

Generated on Sat Apr 30 22:57:48 2011 for MediaWiki by  doxygen 1.5.9