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 a result set of hits on other (multiple) wikis associated with this one
94 * @return SearchResultSet
96 function getInterwikiResults() {
101 * Check if there are results on other wikis
105 function hasInterwikiResults() {
106 return $this->getInterwikiResults() != null;
110 * Fetches next search result, or false.
113 * @return SearchResult
120 * Frees the result set, if applicable.
127 * Did the search contain search syntax? If so, Special:Search won't offer
128 * the user a link to a create a page named by the search string because the
129 * name would contain the search syntax.
132 public function searchContainedSyntax() {
138 * This class is used for different SQL-based search engines shipped with MediaWiki
141 class SqlSearchResultSet
extends SearchResultSet
{
143 protected $mResultSet;
145 function __construct( $resultSet, $terms ) {
146 $this->mResultSet
= $resultSet;
147 $this->mTerms
= $terms;
150 function termMatches() {
151 return $this->mTerms
;
155 if ( $this->mResultSet
=== false ) {
159 return $this->mResultSet
->numRows();
163 if ( $this->mResultSet
=== false ) {
167 $row = $this->mResultSet
->fetchObject();
168 if ( $row === false ) {
172 return SearchResult
::newFromRow( $row );
176 if ( $this->mResultSet
=== false ) {
180 $this->mResultSet
->free();
185 * A SearchResultSet wrapper for SearchEngine::getNearMatch
187 class SearchNearMatchResultSet
extends SearchResultSet
{
188 private $fetched = false;
191 * @param Title|null $match Title if matched, else null
193 public function __construct( $match ) {
194 $this->result
= $match;
197 public function hasResult() {
198 return (bool)$this->result
;
201 public function numRows() {
202 return $this->hasResults() ?
1 : 0;
205 public function next() {
206 if ( $this->fetched ||
!$this->result
) {
209 $this->fetched
= true;
210 return SearchResult
::newFromTitle( $this->result
);