includes/search/SearchResultSet.php

   1 <?php
   2 /**
   3  * Search result sets
   4  *
   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.
   9  *
  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.
  14  *
  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
  19  *
  20  * @file
  21  * @ingroup Search
  22  */
  23
  24 /**
  25  * @ingroup Search
  26  */
  27 class SearchResultSet {
  28         /**
  29          * Fetch an array of regular expression fragments for matching
  30          * the search terms as parsed by this engine in a text extract.
  31          * STUB
  32          *
  33          * @return array
  34          */
  35         function termMatches() {
  36                 return array();
  37         }
  38
  39         function numRows() {
  40                 return 0;
  41         }
  42
  43         /**
  44          * Return true if results are included in this result set.
  45          * STUB
  46          *
  47          * @return bool
  48          */
  49         function hasResults() {
  50                 return false;
  51         }
  52
  53         /**
  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
  57          * settings.
  58          *
  59          * Return null if no total hits number is supported.
  60          *
  61          * @return int
  62          */
  63         function getTotalHits() {
  64                 return null;
  65         }
  66
  67         /**
  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.
  70          *
  71          * @return bool
  72          */
  73         function hasSuggestion() {
  74                 return false;
  75         }
  76
  77         /**
  78          * @return string Suggested query, null if none
  79          */
  80         function getSuggestionQuery() {
  81                 return null;
  82         }
  83
  84         /**
  85          * @return string HTML highlighted suggested query, '' if none
  86          */
  87         function getSuggestionSnippet() {
  88                 return '';
  89         }
  90
  91         /**
  92          * Return a result set of hits on other (multiple) wikis associated with this one
  93          *
  94          * @return SearchResultSet
  95          */
  96         function getInterwikiResults() {
  97                 return null;
  98         }
  99
 100         /**
 101          * Check if there are results on other wikis
 102          *
 103          * @return bool
 104          */
 105         function hasInterwikiResults() {
 106                 return $this->getInterwikiResults() != null;
 107         }
 108
 109         /**
 110          * Fetches next search result, or false.
 111          * STUB
 112          *
 113          * @return SearchResult
 114          */
 115         function next() {
 116                 return false;
 117         }
 118
 119         /**
 120          * Frees the result set, if applicable.
 121          */
 122         function free() {
 123                 // ...
 124         }
 125
 126         /**
 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.
 130          * @return bool
 131          */
 132         public function searchContainedSyntax() {
 133                 return false;
 134         }
 135 }
 136
 137 /**
 138  * This class is used for different SQL-based search engines shipped with MediaWiki
 139  * @ingroup Search
 140  */
 141 class SqlSearchResultSet extends SearchResultSet {
 142         protected $resultSet;
 143         protected $terms;
 144         protected $totalHits;
 145
 146         function __construct( $resultSet, $terms, $total = null ) {
 147                 $this->resultSet = $resultSet;
 148                 $this->terms = $terms;
 149                 $this->totalHits = $total;
 150         }
 151
 152         function termMatches() {
 153                 return $this->terms;
 154         }
 155
 156         function numRows() {
 157                 if ( $this->resultSet === false ) {
 158                         return false;
 159                 }
 160
 161                 return $this->resultSet->numRows();
 162         }
 163
 164         function next() {
 165                 if ( $this->resultSet === false ) {
 166                         return false;
 167                 }
 168
 169                 $row = $this->resultSet->fetchObject();
 170                 if ( $row === false ) {
 171                         return false;
 172                 }
 173
 174                 return SearchResult::newFromRow( $row );
 175         }
 176
 177         function free() {
 178                 if ( $this->resultSet === false ) {
 179                         return false;
 180                 }
 181
 182                 $this->resultSet->free();
 183         }
 184
 185         function getTotalHits() {
 186                 return $this->totalHits;
 187         }
 188 }
 189
 190 /**
 191  * A SearchResultSet wrapper for SearchEngine::getNearMatch
 192  */
 193 class SearchNearMatchResultSet extends SearchResultSet {
 194         private $fetched = false;
 195
 196         /**
 197          * @param Title|null $match Title if matched, else null
 198          */
 199         public function __construct( $match ) {
 200                 $this->result = $match;
 201         }
 202
 203         public function hasResult() {
 204                 return (bool)$this->result;
 205         }
 206
 207         public function numRows() {
 208                 return $this->hasResults() ? 1 : 0;
 209         }
 210
 211         public function next() {
 212                 if ( $this->fetched || !$this->result ) {
 213                         return false;
 214                 }
 215                 $this->fetched = true;
 216                 return SearchResult::newFromTitle( $this->result );
 217         }
 218 }