MediaWiki  REL1_22
Public Member Functions
SearchResultSet Class Reference
Search
Inheritance diagram for SearchResultSet:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 free ()
 Frees the result set, if applicable.
 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.
 getSuggestionQuery ()
 getSuggestionSnippet ()
 getTotalHits ()
 Some search modes return a total hit count for the query in the entire article database.
 hasInterwikiResults ()
 Check if there are results on other wikis.
 hasResults ()
 Return true if results are included in this result set.
 hasSuggestion ()
 Some search modes return a suggested alternate term if there are no exact hits.
 next ()
 Fetches next search result, or false.
 numRows ()
 termMatches ()
 Fetch an array of regular expression fragments for matching the search terms as parsed by this engine in a text extract.

Detailed Description

Definition at line 579 of file SearchEngine.php.

Member Function Documentation

SearchResultSet::free ( )

Frees the result set, if applicable.

Reimplemented in SqlSearchResultSet.

Definition at line 684 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 649 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 658 of file SearchEngine.php.

SearchResultSet::getSuggestionQuery ( )
Returns:
String: suggested query, null if none

Definition at line 632 of file SearchEngine.php.

SearchResultSet::getSuggestionSnippet ( )
Returns:
String: HTML highlighted suggested query, '' if none

Definition at line 639 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 615 of file SearchEngine.php.

SearchResultSet::hasInterwikiResults ( )

Check if there are results on other wikis.

Returns:
Boolean

Definition at line 667 of file SearchEngine.php.

SearchResultSet::hasResults ( )

Return true if results are included in this result set.

STUB

Returns:
Boolean

Definition at line 601 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 625 of file SearchEngine.php.

SearchResultSet::next ( )

Fetches next search result, or false.

STUB

Returns:
SearchResult

Reimplemented in SearchNearMatchResultSet, SqlSearchResultSet, MssqlSearchResultSet, and PostgresSearchResultSet.

Definition at line 677 of file SearchEngine.php.

SearchResultSet::numRows ( )

Reimplemented in SearchNearMatchResultSet, SqlSearchResultSet, and MssqlSearchResultSet.

Definition at line 591 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, and MssqlSearchResultSet.

Definition at line 587 of file SearchEngine.php.

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