SqlSearchResultSet Class Reference

This class is used for different SQL-based search engines shipped with MediaWiki. More...

Inheritance diagram for SqlSearchResultSet:

Collaboration diagram for SqlSearchResultSet:

List of all members.

Public Member Functions
	__construct ($resultSet, $terms, $total=null)
	free ()
	Frees the result set, if applicable.
	getTotalHits ()
	Some search modes return a total hit count for the query in the entire article database.
	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.
Protected Attributes
	$resultSet
	$terms
	$totalHits

---

Detailed Description

This class is used for different SQL-based search engines shipped with MediaWiki.

Definition at line 131 of file SearchResultSet.php.

---

Constructor & Destructor Documentation

SqlSearchResultSet::__construct	(	$	resultSet,
		$	terms,
		$	total = null
	)

Definition at line 136 of file SearchResultSet.php.

References $resultSet, $terms, $total, and terms.

---

Member Function Documentation

SqlSearchResultSet::free

(

)

Frees the result set, if applicable.

Reimplemented from SearchResultSet.

Definition at line 169 of file SearchResultSet.php.

SqlSearchResultSet::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 from SearchResultSet.

Definition at line 177 of file SearchResultSet.php.

References numRows().

SqlSearchResultSet::next

(

)

Fetches next search result, or false.

STUB

Returns:

SearchResult

Reimplemented from SearchResultSet.

Definition at line 154 of file SearchResultSet.php.

References Title\makeTitle(), and SearchResult\newFromTitle().

SqlSearchResultSet::numRows

(

)

Reimplemented from SearchResultSet.

Definition at line 146 of file SearchResultSet.php.

Referenced by getTotalHits().

SqlSearchResultSet::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 from SearchResultSet.

Definition at line 142 of file SearchResultSet.php.

References terms.

---

Member Data Documentation

SqlSearchResultSet::$resultSet [protected]

Definition at line 132 of file SearchResultSet.php.

Referenced by __construct().

SqlSearchResultSet::$terms [protected]

Definition at line 133 of file SearchResultSet.php.

Referenced by __construct().

SqlSearchResultSet::$totalHits [protected]

Definition at line 134 of file SearchResultSet.php.

---

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

• includes/search/SearchResultSet.php