MediaWiki\Search\SearchSqlite Class Reference

Search engine hook for SQLite. More...

Inherits MediaWiki\Search\SearchDatabase.

Collaboration diagram for MediaWiki\Search\SearchSqlite:

Public Member Functions
	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
	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
	updateTitle ( $id, $title)
	Update a search index record's title only.Title should be pre-processed. STUB Parameters int $id string $title
Public Member Functions inherited from MediaWiki\Search\SearchDatabase
	__construct (IConnectionProvider $dbProvider)
	doSearchText ( $term)
	doSearchTitle ( $term)
Public Member Functions inherited from MediaWiki\Search\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.
	getValidSorts ()
	Get the valid sort directions.
	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)

Protected Member Functions
	doSearchTextInDB ( $term)
	Perform a full text search query and return a result set. Parameters string $term Raw search term Returns SqlSearchResultSet|null
	doSearchTitleInDB ( $term)
	Perform a title-only search query and return a result set. Parameters string $term Raw search term Returns SqlSearchResultSet|null
	searchInternal (string $term, bool $fulltext)
Protected Member Functions inherited from MediaWiki\Search\SearchDatabase
	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 MediaWiki\Search\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.

Additional Inherited Members
Static Public Member Functions inherited from MediaWiki\Search\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 MediaWiki\Search\SearchEngine
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)
Static Protected Member Functions inherited from MediaWiki\Search\SearchEngine
static	defaultNearMatcher ()
	Get near matcher for default SearchEngine.
Protected Attributes inherited from MediaWiki\Search\SearchDatabase
IConnectionProvider	$dbProvider
string[]	$searchTerms = []
	search terms
Protected Attributes inherited from MediaWiki\Search\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.

Detailed Description

Search engine hook for SQLite.

Definition at line 19 of file SearchSqlite.php.

Member Function Documentation

doSearchTextInDB()

MediaWiki\Search\SearchSqlite::doSearchTextInDB ( $term )

protected

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

Parameters

string

$term

Raw search term

Returns

SqlSearchResultSet|null

Reimplemented from MediaWiki\Search\SearchDatabase.

Definition at line 154 of file SearchSqlite.php.

References MediaWiki\Search\SearchSqlite\searchInternal().

doSearchTitleInDB()

MediaWiki\Search\SearchSqlite::doSearchTitleInDB ( $term )

protected

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

Parameters

string

$term

Raw search term

Returns

SqlSearchResultSet|null

Reimplemented from MediaWiki\Search\SearchDatabase.

Definition at line 159 of file SearchSqlite.php.

References MediaWiki\Search\SearchSqlite\searchInternal().

legalSearchChars()

MediaWiki\Search\SearchSqlite::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 from MediaWiki\Search\SearchEngine.

Definition at line 144 of file SearchSqlite.php.

searchInternal()

MediaWiki\Search\SearchSqlite::searchInternal ( string $term, bool $fulltext )

protected

Definition at line 163 of file SearchSqlite.php.

Referenced by MediaWiki\Search\SearchSqlite\doSearchTextInDB(), and MediaWiki\Search\SearchSqlite\doSearchTitleInDB().

update()

MediaWiki\Search\SearchSqlite::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 from MediaWiki\Search\SearchEngine.

Definition at line 240 of file SearchSqlite.php.

updateTitle()

MediaWiki\Search\SearchSqlite::updateTitle	(		$id,
			$title )

Update a search index record's title only.Title should be pre-processed. STUB

Parameters

int	$id
string	$title

Reimplemented from MediaWiki\Search\SearchEngine.

Definition at line 258 of file SearchSqlite.php.

---

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

• includes/Search/SearchSqlite.php