Contain a class for special pages. More...

Inherited by SearchDatabase, and SearchEngineDummy.

Public Member Functions
	augmentSearchResults (ISearchResultSet $resultSet)
	Augment search results with extra data.

	completionSearch ( $search)
	Perform a completion search.

	completionSearchWithVariants ( $search)
	Perform a completion search with variants.

	defaultPrefixSearch ( $search)
	Simple prefix search for subpages.

	delete ( $id, $title)
	Delete an indexed page Title should be pre-processed.

	extractTitles (SearchSuggestionSet $completionResults)
	Extract titles from completion results.

	getFeatureData ( $feature)
	Way to retrieve custom data set by setFeatureData or by the engine itself.

	getNearMatcher (Config $config)
	Get service class to finding near matches.

	getProfiles ( $profileType, ?User $user=null)
	Get a list of supported profiles.

	getSearchIndexFields ()
	Get fields for search index.

	getSort ()
	Get the sort direction of the search results.

	getValidSorts ()
	Get the valid sort directions.

	legalSearchChars ( $type=self::CHARS_ALL)
	Get chars legal for search.

	makeSearchFieldMapping ( $name, $type)
	Create a search field definition.

	normalizeText ( $string)
	When overridden in derived class, performs database-specific conversions on text to be used for searching or updating search index.

	searchArchiveTitle ( $term)
	Perform a title search in the article archive.

	searchText ( $term)
	Perform a full text search query and return a result set.

	searchTitle ( $term)
	Perform a title-only search query and return a result set.

	setFeatureData ( $feature, $data)
	Way to pass custom data for engines.

	setHookContainer (HookContainer $hookContainer)

	setLimitOffset ( $limit, $offset=0)
	Set the maximum number of results to return and how many to skip before returning the first.

	setNamespaces ( $namespaces)
	Set which namespaces the search should include.

	setShowSuggestion ( $showSuggestion)
	Set whether the searcher should try to build a suggestion.

	setSort ( $sort)
	Set the sort direction of the search results.

	supports ( $feature)

	update ( $id, $title, $text)
	Create or update the search index record for the given page.

	updateTitle ( $id, $title)
	Update a search index record's title only.

Static Public Member Functions
static	parseNamespacePrefixes ( $query, $withAllKeyword=true, $withPrefixSearchExtractNamespaceHook=false)
	Parse some common prefixes: all (search everything) or namespace names.

static	userHighlightPrefs ()
	Find snippet highlight settings for all users.

Public Attributes
int[] null	$namespaces = [ NS_MAIN ]

string	$prefix = ''

const	COMPLETION_PROFILE_TYPE = 'completionSearchProfile'
	Profile type for completionSearch.

const	DEFAULT_SORT = 'relevance'

const	FT_QUERY_DEP_PROFILE_TYPE = 'fulltextQueryDepProfile'
	Profile type for query dependent ranking features (ex: field weights)

const	FT_QUERY_INDEP_PROFILE_TYPE = 'fulltextQueryIndepProfile'
	Profile type for query independent ranking features (ex: article popularity)

Protected Member Functions
	completionSearchBackend ( $search)
	Perform a completion search.

	completionSearchBackendOverfetch ( $search)
	Perform an overfetch of completion search results.

	doSearchArchiveTitle ( $term)
	Perform a title search in the article archive.

	doSearchText ( $term)
	Perform a full text search query and return a result set.

	doSearchTitle ( $term)
	Perform a title-only search query and return a result set.

	getHookContainer ()
	Get a HookContainer, for running extension hooks or for hook metadata.

	getHookRunner ()
	Get a HookRunner for running core hooks.

	normalizeNamespaces ( $search)
	Makes search simple string if it was namespaced.

	processCompletionResults ( $search, SearchSuggestionSet $suggestions)
	Process completion search results.

	simplePrefixSearch ( $search)
	Call out to simple search backend.

Static Protected Member Functions
static	defaultNearMatcher ()
	Get near matcher for default SearchEngine.

Protected Attributes
array	$features = []
	Feature values.

int	$limit = 10

int	$offset = 0

string[]	$searchTerms = []

bool	$showSuggestion = true

const	CHARS_ALL = 1
	Integer flag for legalSearchChars: includes all chars allowed in a search query.

const	CHARS_NO_SYNTAX = 2
	Integer flag for legalSearchChars: includes all chars allowed in a search term.

Detailed Description

Contain a class for special pages.

Stability: stable: to extend

Definition at line 29 of file SearchEngine.php.

Member Function Documentation

◆ augmentSearchResults()

SearchEngine::augmentSearchResults ( ISearchResultSet $resultSet )

Augment search results with extra data.

Definition at line 797 of file SearchEngine.php.

References getHookRunner(), and ISearchResultSet\setAugmentedData().

◆ completionSearch()

SearchEngine::completionSearch ( $search )

Perform a completion search.

Parameters

string $search

Returns: SearchSuggestionSet

Definition at line 550 of file SearchEngine.php.

References completionSearchBackendOverfetch(), SearchSuggestionSet\emptySuggestionSet(), normalizeNamespaces(), and processCompletionResults().

Referenced by completionSearchWithVariants().

◆ completionSearchBackend()

SearchEngine::completionSearchBackend ( $search )

protected

Perform a completion search.

Does not resolve namespaces and does not check variants. Search engine implementations may want to override this function.

Stability: stable: to override

Parameters

string $search

Returns: SearchSuggestionSet

Definition at line 525 of file SearchEngine.php.

References SearchSuggestionSet\fromStrings(), SearchSuggestionSet\fromTitles(), getHookRunner(), NS_SPECIAL, and simplePrefixSearch().

Referenced by completionSearchBackendOverfetch().

◆ completionSearchBackendOverfetch()

SearchEngine::completionSearchBackendOverfetch ( $search )

protected

Perform an overfetch of completion search results.

This allows determining if another page of results is available.

Parameters

string $search

Returns: SearchSuggestionSet

Definition at line 506 of file SearchEngine.php.

References completionSearchBackend().

Referenced by completionSearch(), and completionSearchWithVariants().

◆ completionSearchWithVariants()

SearchEngine::completionSearchWithVariants ( $search )

Perform a completion search with variants.

Stability: stable: to override

Parameters

string $search

Returns: SearchSuggestionSet

Definition at line 566 of file SearchEngine.php.

References completionSearch(), completionSearchBackendOverfetch(), SearchSuggestionSet\emptySuggestionSet(), normalizeNamespaces(), processCompletionResults(), and setLimitOffset().

◆ defaultNearMatcher()

static SearchEngine::defaultNearMatcher ( )

staticprotected

Get near matcher for default SearchEngine.

Returns: TitleMatcher

Deprecated: since 1.40, MediaWikiServices::getInstance()->getTitleMatcher()

Definition at line 270 of file SearchEngine.php.

References wfDeprecated().

◆ defaultPrefixSearch()

SearchEngine::defaultPrefixSearch ( $search )

Simple prefix search for subpages.

Parameters

string $search

Returns: Title[]

Definition at line 694 of file SearchEngine.php.

References normalizeNamespaces(), and simplePrefixSearch().

◆ delete()

SearchEngine::delete	(		$id,
			$title )

Delete an indexed page Title should be pre-processed.

STUB

Parameters

int	$id	Page id that was deleted
string	$title	Title of page that was deleted

Reimplemented in SearchMySQL.

Definition at line 480 of file SearchEngine.php.

◆ doSearchArchiveTitle()

SearchEngine::doSearchArchiveTitle ( $term )

protected

Perform a title search in the article archive.

Stability: stable: to override

Parameters

string $term Raw search term

Returns: Status

Since: 1.32

Definition at line 135 of file SearchEngine.php.

Referenced by searchArchiveTitle().

◆ doSearchText()

SearchEngine::doSearchText ( $term )

protected

Perform a full text search query and return a result set.

Stability: stable: to override

Parameters

string $term Raw search term

Returns: ISearchResultSet|Status<ISearchResultSet>|null

Since: 1.32

Reimplemented in SearchDatabase.

Definition at line 104 of file SearchEngine.php.

Referenced by searchText().

◆ doSearchTitle()

SearchEngine::doSearchTitle ( $term )

protected

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

Stability: stable: to override

Parameters

string $term Raw search term

Returns: ISearchResultSet|null

Since: 1.32

Reimplemented in SearchDatabase.

Definition at line 165 of file SearchEngine.php.

Referenced by searchTitle().

◆ extractTitles()

SearchEngine::extractTitles ( SearchSuggestionSet $completionResults )

Extract titles from completion results.

Parameters

SearchSuggestionSet $completionResults

Returns: Title[]

Definition at line 605 of file SearchEngine.php.

References SearchSuggestion\getSuggestedTitle(), and SearchSuggestionSet\map().

◆ getFeatureData()

SearchEngine::getFeatureData ( $feature )

Way to retrieve custom data set by setFeatureData or by the engine itself.

Since: 1.29

Parameters

string $feature feature name

Returns: mixed the feature value or null if unset

Definition at line 237 of file SearchEngine.php.

◆ getHookContainer()

SearchEngine::getHookContainer ( )

protected

Get a HookContainer, for running extension hooks or for hook metadata.

Since: 1.35

Returns: HookContainer

Definition at line 842 of file SearchEngine.php.

◆ getHookRunner()

SearchEngine::getHookRunner ( )

protected

Get a HookRunner for running core hooks.

Access: internal: This is for use by core only. Hook interfaces may be removed without notice.

Since: 1.35

Returns: HookRunner

Definition at line 860 of file SearchEngine.php.

Referenced by augmentSearchResults(), completionSearchBackend(), and getSearchIndexFields().

◆ getNearMatcher()

SearchEngine::getNearMatcher ( Config $config )

Get service class to finding near matches.

Returns: TitleMatcher

Deprecated: since 1.40, use MediaWikiServices::getInstance()->getTitleMatcher()

Definition at line 260 of file SearchEngine.php.

◆ getProfiles()

SearchEngine::getProfiles	(		$profileType,
		?User	$user = null )

Get a list of supported profiles.

Some search engine implementations may expose specific profiles to fine-tune its behaviors. The profile can be passed as a feature data with setFeatureData( $profileType, $profileName ) The array returned by this function contains the following keys:

name: the profile name to use with setFeatureData
desc-message: the i18n description
default: set to true if this profile is the default

Since: 1.28

Stability: stable: to override

Parameters

string	$profileType	the type of profiles
User \| null	$user	the user requesting the list of profiles

Returns: array|null the list of profiles or null if none available

Definition at line 733 of file SearchEngine.php.

◆ getSearchIndexFields()

SearchEngine::getSearchIndexFields ( )

Get fields for search index.

Since: 1.28

Returns: SearchIndexField[] Index field definitions for all content handlers

Definition at line 756 of file SearchEngine.php.

References getHookRunner().

◆ getSort()

SearchEngine::getSort ( )

Get the sort direction of the search results.

Since: 1.25

Returns: string

Definition at line 361 of file SearchEngine.php.

◆ getValidSorts()

SearchEngine::getValidSorts ( )

Get the valid sort directions.

All search engines support 'relevance' but others might support more. The default in all implementations must be 'relevance.'

Since: 1.25

Stability: stable: to override

Returns: string[] the valid sort directions for setSort

Definition at line 336 of file SearchEngine.php.

Referenced by setSort().

◆ legalSearchChars()

SearchEngine::legalSearchChars ( $type = self::CHARS_ALL )

Get chars legal for search.

Parameters

int $type type of search chars (see self::CHARS_ALL and self::CHARS_NO_SYNTAX). Defaults to CHARS_ALL

Returns: string

Reimplemented in SearchMySQL, and SearchSqlite.

Definition at line 281 of file SearchEngine.php.

Referenced by SearchDatabase\filter().

◆ makeSearchFieldMapping()

SearchEngine::makeSearchFieldMapping	(		$name,
			$type )

Create a search field definition.

Specific search engines should override this method to create search fields.

Stability: stable: to override

Parameters

string	$name
string	$type	One of the types in SearchIndexField::INDEX_TYPE_*

Returns: SearchIndexField

Since: 1.28

Definition at line 747 of file SearchEngine.php.

Referenced by MediaWiki\Content\ContentHandler\addSearchField(), MediaWiki\Content\ContentHandler\getFieldsForSearchIndex(), MediaWiki\Content\FileContentHandler\getFieldsForSearchIndex(), MediaWiki\Content\TextContentHandler\getFieldsForSearchIndex(), and MediaWiki\Content\WikitextContentHandler\getFieldsForSearchIndex().

◆ normalizeNamespaces()

SearchEngine::normalizeNamespaces ( $search )

protected

Makes search simple string if it was namespaced.

Sets namespaces of the search to namespaces extracted from string.

Parameters

string $search

Returns: string Simplified search string

Definition at line 490 of file SearchEngine.php.

References setNamespaces().

Referenced by completionSearch(), completionSearchWithVariants(), and defaultPrefixSearch().

◆ normalizeText()

SearchEngine::normalizeText ( $string )

When overridden in derived class, performs database-specific conversions on text to be used for searching or updating search index.

Default implementation does nothing (simply returns $string).

Parameters

string $string String to process

Returns: string

Reimplemented in SearchMySQL.

Definition at line 249 of file SearchEngine.php.

◆ parseNamespacePrefixes()

static SearchEngine::parseNamespacePrefixes	(	$query,
		$withAllKeyword = true,
		$withPrefixSearchExtractNamespaceHook = false )

static

Parse some common prefixes: all (search everything) or namespace names.

Parameters

string	$query
bool	$withAllKeyword	activate support of the "all:" keyword and its translations to activate searching on all namespaces.
bool	$withPrefixSearchExtractNamespaceHook	call the PrefixSearchExtractNamespace hook if classic namespace identification did not match.

Returns: false|array false if no namespace was extracted, an array with the parsed query at index 0 and an array of namespaces at index 1 (or null for all namespaces).

Definition at line 378 of file SearchEngine.php.

References NS_MAIN, and wfMessage().

Referenced by SearchDatabase\extractNamespacePrefix().

◆ processCompletionResults()

SearchEngine::processCompletionResults	(		$search,
		SearchSuggestionSet	$suggestions )

protected

Process completion search results.

Resolves the titles and rescores.

Parameters

string	$search
SearchSuggestionSet	$suggestions

Returns: SearchSuggestionSet

Definition at line 618 of file SearchEngine.php.

References SearchSuggestionSet\filter(), SearchSuggestion\getSuggestedTitle(), SearchSuggestionSet\map(), SearchSuggestionSet\prepend(), SearchSuggestionSet\remove(), SearchSuggestionSet\rescore(), and SearchSuggestionSet\shrink().

Referenced by completionSearch(), and completionSearchWithVariants().

◆ searchArchiveTitle()

SearchEngine::searchArchiveTitle ( $term )

Perform a title search in the article archive.

NOTE: these results still should be filtered by matching against PageArchive, permissions checks etc The results returned by this methods are only suggestions and may not end up being shown to the user.

Note: As of 1.32 overriding this function is deprecated. It will be converted to final in 1.34. Override self::doSearchArchiveTitle().

Parameters

string $term Raw search term

Returns: Status

Since: 1.29

Definition at line 122 of file SearchEngine.php.

References doSearchArchiveTitle().

◆ searchText()

SearchEngine::searchText ( $term )

Perform a full text search query and return a result set.

If full text searches are not supported or disabled, return null.

Note: As of 1.32 overriding this function is deprecated. It will be converted to final in 1.34. Override self::doSearchText().

Parameters

string $term Raw search term

Returns: ISearchResultSet|Status<ISearchResultSet>|null

Definition at line 89 of file SearchEngine.php.

References doSearchText().

◆ searchTitle()

SearchEngine::searchTitle ( $term )

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

If title searches are not supported or disabled, return null. STUB

Note: As of 1.32 overriding this function is deprecated. It will be converted to final in 1.34. Override self::doSearchTitle().

Parameters

string $term Raw search term

Returns: ISearchResultSet|null

Definition at line 150 of file SearchEngine.php.

References doSearchTitle().

◆ setFeatureData()

SearchEngine::setFeatureData	(		$feature,
			$data )

Way to pass custom data for engines.

Since: 1.18

Parameters

string	$feature
mixed	$data

Definition at line 226 of file SearchEngine.php.

◆ setHookContainer()

SearchEngine::setHookContainer ( HookContainer $hookContainer )

Since: 1.35

Access: internal

Parameters

HookContainer $hookContainer

Definition at line 831 of file SearchEngine.php.

◆ setLimitOffset()

SearchEngine::setLimitOffset	(		$limit,
			$offset = 0 )

Set the maximum number of results to return and how many to skip before returning the first.

Parameters

int	$limit
int	$offset

Definition at line 292 of file SearchEngine.php.

Referenced by completionSearchWithVariants().

◆ setNamespaces()

SearchEngine::setNamespaces ( $namespaces )

Set which namespaces the search should include.

Give an array of namespace index numbers.

Parameters

int[] | null $namespaces

Definition at line 303 of file SearchEngine.php.

References $namespaces.

Referenced by normalizeNamespaces().

◆ setShowSuggestion()

SearchEngine::setShowSuggestion ( $showSuggestion )

Set whether the searcher should try to build a suggestion.

Note: some searchers don't support building a suggestion in the first place and others don't respect this flag.

Parameters

bool $showSuggestion Should the searcher try to build suggestions

Definition at line 323 of file SearchEngine.php.

◆ setSort()

SearchEngine::setSort ( $sort )

Set the sort direction of the search results.

Must be one returned by SearchEngine::getValidSorts()

Since: 1.25

Parameters

string $sort sort direction for query result

Definition at line 347 of file SearchEngine.php.

References getValidSorts().

◆ simplePrefixSearch()

SearchEngine::simplePrefixSearch ( $search )

protected

Call out to simple search backend.

Defaults to TitlePrefixSearch.

Parameters

string $search

Returns: Title[]

Definition at line 709 of file SearchEngine.php.

References PrefixSearch\defaultSearchBackend().

Referenced by completionSearchBackend(), and defaultPrefixSearch().

◆ supports()

SearchEngine::supports ( $feature )

Since: 1.18

Stability: stable: to override

Parameters

string $feature

Returns: bool

Reimplemented in SearchMySQL.

Definition at line 210 of file SearchEngine.php.

◆ update()

SearchEngine::update	(	$id,
		$title,
		$text )

Create or update the search index record for the given page.

Title and text should be pre-processed. STUB

Parameters

int	$id
string	$title
string	$text

Reimplemented in SearchMySQL, SearchSqlite, and SearchPostgres.

Definition at line 456 of file SearchEngine.php.

◆ updateTitle()

SearchEngine::updateTitle	(		$id,
			$title )

Update a search index record's title only.

Title should be pre-processed. STUB

Parameters

int	$id
string	$title

Reimplemented in SearchMySQL, SearchPostgres, and SearchSqlite.

Definition at line 468 of file SearchEngine.php.

◆ userHighlightPrefs()

static SearchEngine::userHighlightPrefs ( )

static

Find snippet highlight settings for all users.

Returns: array Contextlines, contextchars

Deprecated: since 1.34; use the SearchHighlighter constants directly

See also: SearchHighlighter::DEFAULT_CONTEXT_CHARS; SearchHighlighter::DEFAULT_CONTEXT_LINES

Definition at line 441 of file SearchEngine.php.

References SearchHighlighter\DEFAULT_CONTEXT_CHARS, and SearchHighlighter\DEFAULT_CONTEXT_LINES.

Member Data Documentation

◆ $features

array SearchEngine::$features = []

protected

Feature values.

Definition at line 56 of file SearchEngine.php.

◆ $limit

int SearchEngine::$limit = 10

protected

Definition at line 39 of file SearchEngine.php.

◆ $namespaces

int [] null SearchEngine::$namespaces = [ NS_MAIN ]

Definition at line 36 of file SearchEngine.php.

Referenced by setNamespaces().

◆ $offset

int SearchEngine::$offset = 0

protected

Definition at line 42 of file SearchEngine.php.

◆ $prefix

string SearchEngine::$prefix = ''

Definition at line 33 of file SearchEngine.php.

◆ $searchTerms

string [] SearchEngine::$searchTerms = []

protected

Deprecated: since 1.34

Definition at line 48 of file SearchEngine.php.

◆ $showSuggestion

bool SearchEngine::$showSuggestion = true

protected

Definition at line 51 of file SearchEngine.php.

◆ CHARS_ALL

const SearchEngine::CHARS_ALL = 1

protected

Integer flag for legalSearchChars: includes all chars allowed in a search query.

Definition at line 74 of file SearchEngine.php.

◆ CHARS_NO_SYNTAX

const SearchEngine::CHARS_NO_SYNTAX = 2

protected

Integer flag for legalSearchChars: includes all chars allowed in a search term.

Definition at line 77 of file SearchEngine.php.

◆ COMPLETION_PROFILE_TYPE

const SearchEngine::COMPLETION_PROFILE_TYPE = 'completionSearchProfile'

Profile type for completionSearch.

Definition at line 65 of file SearchEngine.php.

◆ DEFAULT_SORT

const SearchEngine::DEFAULT_SORT = 'relevance'

Definition at line 30 of file SearchEngine.php.

◆ FT_QUERY_DEP_PROFILE_TYPE

const SearchEngine::FT_QUERY_DEP_PROFILE_TYPE = 'fulltextQueryDepProfile'

Profile type for query dependent ranking features (ex: field weights)

Definition at line 71 of file SearchEngine.php.

◆ FT_QUERY_INDEP_PROFILE_TYPE

const SearchEngine::FT_QUERY_INDEP_PROFILE_TYPE = 'fulltextQueryIndepProfile'

Profile type for query independent ranking features (ex: article popularity)

Definition at line 68 of file SearchEngine.php.

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

includes/Search/SearchEngine.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ augmentSearchResults()

◆ completionSearch()

◆ completionSearchBackend()

◆ completionSearchBackendOverfetch()

◆ completionSearchWithVariants()

◆ defaultNearMatcher()

◆ defaultPrefixSearch()

◆ delete()

◆ doSearchArchiveTitle()

◆ doSearchText()

◆ doSearchTitle()

◆ extractTitles()

◆ getFeatureData()

◆ getHookContainer()

◆ getHookRunner()

◆ getNearMatcher()

◆ getProfiles()

◆ getSearchIndexFields()

◆ getSort()

◆ getValidSorts()

◆ legalSearchChars()

◆ makeSearchFieldMapping()

◆ normalizeNamespaces()

◆ normalizeText()

◆ parseNamespacePrefixes()

◆ processCompletionResults()

◆ searchArchiveTitle()

◆ searchText()

◆ searchTitle()

◆ setFeatureData()

◆ setHookContainer()

◆ setLimitOffset()

◆ setNamespaces()

◆ setShowSuggestion()

◆ setSort()

◆ simplePrefixSearch()

◆ supports()

◆ update()

◆ updateTitle()

◆ userHighlightPrefs()

Member Data Documentation

◆ $features

◆ $limit

◆ $namespaces

◆ $offset

◆ $prefix

◆ $searchTerms

◆ $showSuggestion

◆ CHARS_ALL

◆ CHARS_NO_SYNTAX

◆ COMPLETION_PROFILE_TYPE

◆ DEFAULT_SORT

◆ FT_QUERY_DEP_PROFILE_TYPE

◆ FT_QUERY_INDEP_PROFILE_TYPE