5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
27 class SearchResultSet
{
29 * Fetch an array of regular expression fragments for matching
30 * the search terms as parsed by this engine in a text extract.
35 function termMatches() {
44 * Return true if results are included in this result set.
49 function hasResults() {
54 * Some search modes return a total hit count for the query
55 * in the entire article database. This may include pages
56 * in namespaces that would not be matched on the given
59 * Return null if no total hits number is supported.
63 function getTotalHits() {
68 * Some search modes return a suggested alternate term if there are
69 * no exact hits. Returns true if there is one on this set.
73 function hasSuggestion() {
78 * @return String: suggested query, null if none
80 function getSuggestionQuery() {
85 * @return String: HTML highlighted suggested query, '' if none
87 function getSuggestionSnippet() {
92 * Return information about how and from where the results were fetched,
93 * should be useful for diagnostics and debugging
102 * Return a result set of hits on other (multiple) wikis associated with this one
104 * @return SearchResultSet
106 function getInterwikiResults() {
111 * Check if there are results on other wikis
115 function hasInterwikiResults() {
116 return $this->getInterwikiResults() != null;
120 * Fetches next search result, or false.
123 * @return SearchResult
130 * Frees the result set, if applicable.
137 * Did the search contain search syntax? If so, Special:Search won't offer
138 * the user a link to a create a page named by the search string because the
139 * name would contain the search syntax.
141 public function searchContainedSyntax() {
147 * This class is used for different SQL-based search engines shipped with MediaWiki
150 class SqlSearchResultSet
extends SearchResultSet
{
152 protected $mResultSet;
154 function __construct( $resultSet, $terms ) {
155 $this->mResultSet
= $resultSet;
156 $this->mTerms
= $terms;
159 function termMatches() {
160 return $this->mTerms
;
164 if ( $this->mResultSet
=== false ) {
168 return $this->mResultSet
->numRows();
172 if ( $this->mResultSet
=== false ) {
176 $row = $this->mResultSet
->fetchObject();
177 if ( $row === false ) {
181 return SearchResult
::newFromRow( $row );
185 if ( $this->mResultSet
=== false ) {
189 $this->mResultSet
->free();
194 * A SearchResultSet wrapper for SearchEngine::getNearMatch
196 class SearchNearMatchResultSet
extends SearchResultSet
{
197 private $fetched = false;
200 * @param $match mixed Title if matched, else null
202 public function __construct( $match ) {
203 $this->result
= $match;
206 public function hasResult() {
207 return (bool)$this->result
;
210 public function numRows() {
211 return $this->hasResults() ?
1 : 0;
214 public function next() {
215 if ( $this->fetched ||
!$this->result
) {
218 $this->fetched
= true;
219 return SearchResult
::newFromTitle( $this->result
);