MediaWiki  REL1_24
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.
 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.
 hasSuggestion ()
 Some search modes return a suggested alternate term if there are no exact hits.
 next ()
 Fetches next search result, or false.
 numRows ()
 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.
 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 27 of file SearchResultSet.php.

Member Function Documentation

SearchResultSet::free ( )

Frees the result set, if applicable.

Reimplemented in SqlSearchResultSet.

Definition at line 112 of file SearchResultSet.php.

SearchResultSet::getInterwikiResults ( )

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

Returns:
SearchResultSet

Definition at line 86 of file SearchResultSet.php.

Referenced by hasInterwikiResults().

SearchResultSet::getSuggestionQuery ( )
Returns:
string Suggested query, null if none

Definition at line 70 of file SearchResultSet.php.

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

Definition at line 77 of file SearchResultSet.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

Reimplemented in SqlSearchResultSet.

Definition at line 53 of file SearchResultSet.php.

SearchResultSet::hasInterwikiResults ( )

Check if there are results on other wikis.

Returns:
bool

Definition at line 95 of file SearchResultSet.php.

References getInterwikiResults().

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

Definition at line 63 of file SearchResultSet.php.

SearchResultSet::next ( )

Fetches next search result, or false.

STUB

Returns:
SearchResult

Reimplemented in SearchNearMatchResultSet, and SqlSearchResultSet.

Definition at line 105 of file SearchResultSet.php.

SearchResultSet::numRows ( )

Reimplemented in SearchNearMatchResultSet, and SqlSearchResultSet.

Definition at line 39 of file SearchResultSet.php.

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

Definition at line 122 of file SearchResultSet.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 35 of file SearchResultSet.php.

References array().

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