1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
|
<?php
/**
* Search result sets
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Search
*/
use MediaWiki\Title\Title;
/**
* @ingroup Search
*/
class SearchResultSet extends BaseSearchResultSet {
use SearchResultSetTrait;
/** @var bool */
protected $containedSyntax = false;
/**
* Cache of titles.
* Lists titles of the result set, in the same order as results.
* @var Title[]|null
*/
private $titles;
/**
* Cache of results - serialization of the result iterator
* as an array.
* @var SearchResult[]
*/
protected $results;
/**
* @var bool True when there are more pages of search results available.
*/
private $hasMoreResults;
/**
* @param bool $containedSyntax True when query is not requesting a simple
* term match
* @param bool $hasMoreResults True when there are more pages of search
* results available.
*/
public function __construct( $containedSyntax = false, $hasMoreResults = false ) {
if ( static::class === self::class ) {
// This class will eventually be abstract. SearchEngine implementations
// already have to extend this class anyways to provide the actual
// search results.
wfDeprecated( __METHOD__, '1.32' );
}
$this->containedSyntax = $containedSyntax;
$this->hasMoreResults = $hasMoreResults;
}
public function numRows() {
return $this->count();
}
final public function count(): int {
return count( $this->extractResults() );
}
/**
* 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.
*
* @return int|null
*/
public function getTotalHits() {
return null;
}
/**
* Some search modes will run an alternative query that it thinks gives
* a better result than the provided search. Returns true if this has
* occurred.
*
* @return bool
*/
public function hasRewrittenQuery() {
return false;
}
/**
* @return string|null The search the query was internally rewritten to,
* or null when the result of the original query was returned.
*/
public function getQueryAfterRewrite() {
return null;
}
/**
* @return HtmlArmor|string|null Same as self::getQueryAfterRewrite(), but
* with changes highlighted if HtmlArmor is returned. Null when the query
* was not rewritten.
*/
public function getQueryAfterRewriteSnippet() {
return null;
}
/**
* Some search modes return a suggested alternate term if there are
* no exact hits. Returns true if there is one on this set.
*
* @return bool
*/
public function hasSuggestion() {
return false;
}
/**
* @return string|null Suggested query, null if none
*/
public function getSuggestionQuery() {
return null;
}
/**
* @return HtmlArmor|string HTML highlighted suggested query, '' if none
*/
public function getSuggestionSnippet() {
return '';
}
/**
* Return a result set of hits on other (multiple) wikis associated with this one
*
* @param int $type
* @return ISearchResultSet[]|null
*/
public function getInterwikiResults( $type = self::SECONDARY_RESULTS ) {
return null;
}
/**
* Check if there are results on other wikis
*
* @param int $type
* @return bool
*/
public function hasInterwikiResults( $type = self::SECONDARY_RESULTS ) {
return false;
}
/**
* 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.
* @return bool
*/
public function searchContainedSyntax() {
return $this->containedSyntax;
}
/**
* @return bool True when there are more pages of search results available.
*/
public function hasMoreResults() {
return $this->hasMoreResults;
}
/**
* @param int $limit Shrink result set to $limit and flag
* if more results are available.
*/
public function shrink( $limit ) {
if ( $this->count() > $limit ) {
$this->hasMoreResults = true;
// shrinking result set for implementations that
// have not implemented extractResults and use
// the default cache location. Other implementations
// must override this as well.
if ( is_array( $this->results ) ) {
$this->results = array_slice( $this->results, 0, $limit );
$this->titles = null;
} else {
throw new \UnexpectedValueException(
"When overriding result store extending classes must "
. " also override " . __METHOD__ );
}
}
}
/**
* Extract all the results in the result set as array.
* @return SearchResult[]
*/
public function extractResults() {
if ( $this->results === null ) {
$this->results = [];
if ( $this->numRows() == 0 ) {
// Don't bother if we've got empty result
return $this->results;
}
$this->rewind();
foreach ( $this as $result ) {
$this->results[] = $result;
}
$this->rewind();
}
return $this->results;
}
/**
* Extract all the titles in the result set.
* @return Title[]
*/
public function extractTitles() {
if ( $this->titles === null ) {
if ( $this->numRows() == 0 ) {
// Don't bother if we've got empty result
$this->titles = [];
} else {
$this->titles = array_map(
static function ( SearchResult $result ) {
return $result->getTitle();
},
$this->extractResults() );
}
}
return $this->titles;
}
}
|
