Semantic MediaWiki and related extensions
Public Member Functions | List of all members
SMW\MediaWiki\Search\SearchResultSet Class Reference
Inheritance diagram for SMW\MediaWiki\Search\SearchResultSet:
Inheritance graph
[legend]
Collaboration diagram for SMW\MediaWiki\Search\SearchResultSet:
Collaboration graph
[legend]

Public Member Functions

 __construct (\SMWQueryResult $result, $count=null)
 
 numRows ()
 
 hasResults ()
 
 next ()
 
 newSearchSuggestionSet ()
 
 extractResults ()
 
 searchContainedSyntax ()
 
 getTotalHits ()
 
 termMatches ()
 

Detailed Description

GNU GPL v2+

Since
2.1
Author
Stephan Gambke

Member Function Documentation

◆ extractResults()

SMW\MediaWiki\Search\SearchResultSet::extractResults ( )

◆ hasResults()

SMW\MediaWiki\Search\SearchResultSet::hasResults ( )

Return true if results are included in this result set.

Returns
bool

◆ newSearchSuggestionSet()

SMW\MediaWiki\Search\SearchResultSet::newSearchSuggestionSet ( )
Since
3.0
Returns
SearchSuggestionSet

◆ next()

SMW\MediaWiki\Search\SearchResultSet::next ( )

Fetches next search result, or false.

Returns
SearchResult

◆ numRows()

SMW\MediaWiki\Search\SearchResultSet::numRows ( )

Return number of rows included in this result set.

Returns
int|void

◆ searchContainedSyntax()

SMW\MediaWiki\Search\SearchResultSet::searchContainedSyntax ( )

Returns true, 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, i.e. the SMW query.

Returns
bool

◆ termMatches()

SMW\MediaWiki\Search\SearchResultSet::termMatches ( )

Return an array of regular expression fragments for matching the search terms as parsed by the engine in a text extract.

This is a temporary hack for MW versions that can not cope with no search term being returned (<1.24).

Deprecated:
remove once min supported MW version has ::highlightNone()
Returns
string[]

The documentation for this class was generated from the following file:

About | General disclaimer | Privacy policy