Base search engine base class for database-backed searches. More...

Inheritance diagram for SearchDatabase:

[legend]

Collaboration diagram for SearchDatabase:

[legend]

Public Member Functions
	__construct (ILoadBalancer $lb)

	doSearchText ( $term)

	doSearchTitle ( $term)

Public Member Functions inherited from SearchEngine
	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.

	getTextFromContent (Title $t, Content $c=null)
	Get the raw text for updating the index from a content object Nicer search backends could possibly do something cooler than just returning raw text.

	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.

	replacePrefixes ( $query)
	Parse some common prefixes: all (search everything) or namespace names and set the list of namespaces of this class accordingly.

	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)

	textAlreadyUpdatedForIndex ()
	If an implementation of SearchEngine handles all of its own text processing in getTextFromContent() and doesn't require SearchUpdate::updateText()'s rather silly handling, it should return true here instead.

	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.

Protected Member Functions
	doSearchTextInDB ( $term)
	Perform a full text search query and return a result set.

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

	extractNamespacePrefix ( $term)
	Extract the optional namespace prefix and set self::namespaces accordingly and return the query string.

	filter ( $text)
	Return a 'cleaned up' search string.

Protected Member Functions inherited from SearchEngine
	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.

	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.

Protected Attributes
IDatabase	$db
	(backwards compatibility)

ILoadBalancer	$lb

string[]	$searchTerms = []
	search terms

Protected Attributes inherited from SearchEngine
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.

Additional Inherited Members
Static Public Member Functions inherited from SearchEngine
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 inherited from SearchEngine
int[] null	$namespaces = [ NS_MAIN ]

string	$prefix = ''

const	COMPLETION_PROFILE_TYPE = 'completionSearchProfile'
	Profile type for completionSearch.

const	DEFAULT_SORT = 'relevance'

const	FT_QUERY_INDEP_PROFILE_TYPE = 'fulltextQueryIndepProfile'
	Profile type for query independent ranking features.

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

Detailed Description

Base search engine base class for database-backed searches.

Stability: stable: to extend

Since: 1.23

Definition at line 33 of file SearchDatabase.php.

Constructor & Destructor Documentation

◆ __construct()

SearchDatabase::__construct ( ILoadBalancer $lb )

Parameters

ILoadBalancer $lb The load balancer for the DB cluster to search on

Definition at line 47 of file SearchDatabase.php.

References $lb, DB_REPLICA, and Wikimedia\Rdbms\ILoadBalancer\getLazyConnectionRef().

Member Function Documentation

◆ doSearchText()

SearchDatabase::doSearchText ( $term )

final

Parameters

string $term

Returns: ISearchResultSet|Status|null

Reimplemented from SearchEngine.

Definition at line 57 of file SearchDatabase.php.

References doSearchTextInDB(), and extractNamespacePrefix().

◆ doSearchTextInDB()

SearchDatabase::doSearchTextInDB ( $term )

abstractprotected

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

Parameters

string $term Raw search term

Returns: SqlSearchResultSet|null

Reimplemented in SearchMySQL, SearchPostgres, and SearchSqlite.

Referenced by doSearchText().

◆ doSearchTitle()

SearchDatabase::doSearchTitle ( $term )

final

Parameters

string $term

Returns: ISearchResultSet|null

Reimplemented from SearchEngine.

Definition at line 73 of file SearchDatabase.php.

References doSearchTitleInDB(), and extractNamespacePrefix().

◆ doSearchTitleInDB()

SearchDatabase::doSearchTitleInDB ( $term )

abstractprotected

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

Parameters

string $term Raw search term

Returns: SqlSearchResultSet|null

Reimplemented in SearchMySQL, SearchPostgres, and SearchSqlite.

Referenced by doSearchTitle().

◆ extractNamespacePrefix()

SearchDatabase::extractNamespacePrefix ( $term )

finalprotected

Extract the optional namespace prefix and set self::namespaces accordingly and return the query string.

Parameters

string $term

Returns: string the query string without any namespace prefix

Definition at line 105 of file SearchDatabase.php.

References SearchEngine\parseNamespacePrefixes().

Referenced by doSearchText(), and doSearchTitle().

◆ filter()

SearchDatabase::filter ( $text )

protected

Return a 'cleaned up' search string.

Parameters

string $text

Returns: string

Definition at line 91 of file SearchDatabase.php.

References SearchEngine\legalSearchChars().

Referenced by SearchMySQL\searchInternal(), and SearchSqlite\searchInternal().

Member Data Documentation

◆ $db

IDatabase SearchDatabase::$db

protected

(backwards compatibility)

Definition at line 37 of file SearchDatabase.php.

◆ $lb

ILoadBalancer SearchDatabase::$lb

protected

Definition at line 35 of file SearchDatabase.php.

Referenced by __construct().

◆ $searchTerms

string [] SearchDatabase::$searchTerms = []

protected

search terms

Definition at line 42 of file SearchDatabase.php.

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

includes/search/SearchDatabase.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ doSearchText()

◆ doSearchTextInDB()

◆ doSearchTitle()

◆ doSearchTitleInDB()

◆ extractNamespacePrefix()

◆ filter()

Member Data Documentation

◆ $db

◆ $lb

◆ $searchTerms