[ Index ]

PHP Cross Reference of MediaWiki-1.24.0

title

Body

[close]

/includes/search/ -> SearchResultSet.php (summary)

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.

File Size: 211 lines (4 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 3 classes

SearchResultSet:: (11 methods):
  termMatches()
  numRows()
  getTotalHits()
  hasSuggestion()
  getSuggestionQuery()
  getSuggestionSnippet()
  getInterwikiResults()
  hasInterwikiResults()
  next()
  free()
  searchContainedSyntax()

SqlSearchResultSet:: (6 methods):
  __construct()
  termMatches()
  numRows()
  next()
  free()
  getTotalHits()

SearchNearMatchResultSet:: (3 methods):
  __construct()
  numRows()
  next()


Class: SearchResultSet  - X-Ref


termMatches()   X-Ref
Fetch an array of regular expression fragments for matching
the search terms as parsed by this engine in a text extract.
STUB

return: array

numRows()   X-Ref
No description

getTotalHits()   X-Ref
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

hasSuggestion()   X-Ref
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

getSuggestionQuery()   X-Ref

return: string Suggested query, null if none

getSuggestionSnippet()   X-Ref

return: string HTML highlighted suggested query, '' if none

getInterwikiResults()   X-Ref
Return a result set of hits on other (multiple) wikis associated with this one

return: SearchResultSet

hasInterwikiResults()   X-Ref
Check if there are results on other wikis

return: bool

next()   X-Ref
Fetches next search result, or false.
STUB

return: SearchResult

free()   X-Ref
Frees the result set, if applicable.


searchContainedSyntax()   X-Ref
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

Class: SqlSearchResultSet  - X-Ref

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

__construct( $resultSet, $terms, $total = null )   X-Ref
No description

termMatches()   X-Ref
No description

numRows()   X-Ref
No description

next()   X-Ref
No description

free()   X-Ref
No description

getTotalHits()   X-Ref
No description

Class: SearchNearMatchResultSet  - X-Ref

A SearchResultSet wrapper for SearchEngine::getNearMatch

__construct( $match )   X-Ref

param: Title|null $match Title if matched, else null

numRows()   X-Ref
No description

next()   X-Ref
No description



Generated: Fri Nov 28 14:03:12 2014 Cross-referenced by PHPXref 0.7.1