SearchResultSet Class Reference
[Search]

Inherited by IBM_DB2SearchResultSet, MySQLSearchResultSet, OracleSearchResultSet, and PostgresSearchResultSet.

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 418 of file SearchEngine.php.


Member Function Documentation

SearchResultSet::free (  ) 

Frees the result set, if applicable.

@ access public

Reimplemented in MySQLSearchResultSet.

Definition at line 527 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 490 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 499 of file SearchEngine.php.

Referenced by hasInterwikiResults().

SearchResultSet::getSuggestionQuery (  ) 

Returns:
string suggested query, null if none

Definition at line 473 of file SearchEngine.php.

SearchResultSet::getSuggestionSnippet (  ) 

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

Definition at line 480 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:
int
Access:
public

Definition at line 455 of file SearchEngine.php.

SearchResultSet::hasInterwikiResults (  ) 

Check if there are results on other wikis.

Returns:
boolean

Definition at line 508 of file SearchEngine.php.

References getInterwikiResults().

SearchResultSet::hasResults (  ) 

Return true if results are included in this result set.

Returns:
bool

Definition at line 440 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:
bool
Access:
public

Definition at line 466 of file SearchEngine.php.

SearchResultSet::next (  ) 

Fetches next search result, or false.

Returns:
SearchResult
Access:
public

Reimplemented in IBM_DB2SearchResultSet, MySQLSearchResultSet, OracleSearchResultSet, and PostgresSearchResultSet.

Definition at line 519 of file SearchEngine.php.

SearchResultSet::numRows (  ) 

SearchResultSet::termMatches (  ) 

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

Returns:
array
Access:
public

Reimplemented in IBM_DB2SearchResultSet, MySQLSearchResultSet, OracleSearchResultSet, and PostgresSearchResultSet.

Definition at line 427 of file SearchEngine.php.


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

Generated on Sat Sep 5 02:08:46 2009 for MediaWiki by  doxygen 1.5.9