SMW\MediaWiki\Search\ExtendedSearch Class Reference

Public Member Functions
	__construct (Store $store, SearchEngine $fallbackSearchEngine)
	setExtraPrefixMap (array $extraPrefixMap)
	setQueryBuilder (QueryBuilder $queryBuilder)
	setPrefix ( $prefix)
	setNamespaces (array $namespaces)
	setSearchableNamespaces (array $searchableNamespaces)
	setLimitOffset ( $limit, $offset=0)
	setCompletionSearchTerm ( $completionSearchTerm)
	getLimit ()
	getOffset ()
	getErrors ()
	getQueryString ()
	getQueryLink ()
	getValidSorts ()
	searchTitle ( $term)
	searchText ( $term)
	completionSearch ( $search)

Public Attributes
const	COMPLETION_SEARCH_EXTRA_SEARCH_SIZE = 10

Detailed Description

Search engine that will try to find wiki pages by interpreting the search term as an SMW query.

If successful, the pages according to the query will be returned. If not it falls back to the default search engine.

GNU GPL v2+

Since

2.1

Author

Stephan Gambke

Constructor & Destructor Documentation

__construct()

SMW\MediaWiki\Search\ExtendedSearch::__construct	(	Store	$store,
		SearchEngine	$fallbackSearchEngine
	)

Since

3.1

Parameters

Store	$store
SearchEngine	$fallbackSearchEngine

Member Function Documentation

completionSearch()

SMW\MediaWiki\Search\ExtendedSearch::completionSearch

(

$search

)

Perform a completion search.

Parameters

string

$search

Returns

SearchSuggestionSet

getErrors()

SMW\MediaWiki\Search\ExtendedSearch::getErrors

(

)

Since

3.0

Returns

[]

getLimit()

SMW\MediaWiki\Search\ExtendedSearch::getLimit

(

)

Since

3.1

Returns

integer

getOffset()

SMW\MediaWiki\Search\ExtendedSearch::getOffset

(

)

Since

3.1

Returns

integer

getQueryLink()

SMW\MediaWiki\Search\ExtendedSearch::getQueryLink

(

)

Since

3.0

Returns

string

getQueryString()

SMW\MediaWiki\Search\ExtendedSearch::getQueryString

(

)

Since

3.0

Returns

string

getValidSorts()

SMW\MediaWiki\Search\ExtendedSearch::getValidSorts

(

)

Since

3.0

Returns

array

searchText()

SMW\MediaWiki\Search\ExtendedSearch::searchText

(

$term

)

Perform a full text search query and return a result set. If title searches are not supported or disabled, return null.

Parameters

string

$term

Raw search term

Returns

SearchResultSet||null

searchTitle()

SMW\MediaWiki\Search\ExtendedSearch::searchTitle

(

$term

)

Perform a title-only search query and return a result set.

This method will try to find wiki pages by interpreting the search term as an SMW query.

If successful, the pages according to the query will be returned. If not, it falls back to the default search engine.

Parameters

string

$term

Raw search term

Returns

SearchResultSet|null

setCompletionSearchTerm()

SMW\MediaWiki\Search\ExtendedSearch::setCompletionSearchTerm

(

$completionSearchTerm

)

Since

3.2

Parameters

string

$completionSearchTerm

setExtraPrefixMap()

SMW\MediaWiki\Search\ExtendedSearch::setExtraPrefixMap

(

array

$extraPrefixMap

)

Since

3.1

Parameters

array

$extraPrefixMap

setLimitOffset()

SMW\MediaWiki\Search\ExtendedSearch::setLimitOffset	(		$limit,
			$offset = 0
	)

Since

3.1

Parameters

integer	$limit
integer	$offset

setNamespaces()

SMW\MediaWiki\Search\ExtendedSearch::setNamespaces

(

array

$namespaces

)

Since

3.1

Parameters

array

$namespaces

setPrefix()

SMW\MediaWiki\Search\ExtendedSearch::setPrefix

(

$prefix

)

Since

3.1

Parameters

string

$prefix

setQueryBuilder()

SMW\MediaWiki\Search\ExtendedSearch::setQueryBuilder

(

QueryBuilder

$queryBuilder

)

Since

3.1

Parameters

QueryBuilder

$queryBuilder

setSearchableNamespaces()

SMW\MediaWiki\Search\ExtendedSearch::setSearchableNamespaces

(

array

$searchableNamespaces

)

Since

3.1

Parameters

array

$searchableNamespaces

Member Data Documentation

COMPLETION_SEARCH_EXTRA_SEARCH_SIZE

const SMW\MediaWiki\Search\ExtendedSearch::COMPLETION_SEARCH_EXTRA_SEARCH_SIZE = 10

To provide a wider search radius for the completion search

---

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

• ExtendedSearch.php