BlueSpice MediaWiki REL1_27
 All Classes Namespaces Files Functions Variables Groups Pages
SMW\MediaWiki\Search\SearchResultSet Class Reference
Inheritance diagram for SMW\MediaWiki\Search\SearchResultSet:
Collaboration diagram for SMW\MediaWiki\Search\SearchResultSet:

Public Member Functions

 __construct (\SMWQueryResult $result, $count=null)
 
 numRows ()
 
 hasResults ()
 
 next ()
 
 searchContainedSyntax ()
 
 getTotalHits ()
 
 termMatches ()
 
- Public Member Functions inherited from SearchResultSet
 __construct ($containedSyntax=false)
 
 termMatches ()
 
 numRows ()
 
 getTotalHits ()
 
 hasRewrittenQuery ()
 
 getQueryAfterRewrite ()
 
 getQueryAfterRewriteSnippet ()
 
 hasSuggestion ()
 
 getSuggestionQuery ()
 
 getSuggestionSnippet ()
 
 getInterwikiResults ($type=self::SECONDARY_RESULTS)
 
 hasInterwikiResults ($type=self::SECONDARY_RESULTS)
 
 next ()
 
 rewind ()
 
 free ()
 
 searchContainedSyntax ()
 

Additional Inherited Members

- Public Attributes inherited from SearchResultSet
const SECONDARY_RESULTS = 0
 
const INLINE_RESULTS = 1
 
- Protected Attributes inherited from SearchResultSet
 $containedSyntax = false
 

Detailed Description

GNU GPL v2+

Since
2.1
Author
Stephan Gambke

Member Function Documentation

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

Return true if results are included in this result set.

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

Fetches next search result, or false.

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

Return number of rows included in this result set.

Returns
int|void
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
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: