Search engine hook for MySQL 4+. More...

Inheritance diagram for SearchMySQL:

[legend]

Collaboration diagram for SearchMySQL:

[legend]

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

	getCountQuery ( $filteredTerm, $fulltext)

	getIndexField ( $fulltext)
	Picks which field to index on, depending on what type of query.

	getQuery ( $filteredTerm, $fulltext)
	Construct the SQL query to do the search.

	normalizeText ( $string)
	Converts some characters for MySQL's indexing to grok it correctly, and pads short words to overcome limitations.

	parseQuery ( $filteredText, $fulltext)
	Parse the user's query and transform it into an SQL fragment which will become part of a WHERE clause.

	queryMain (&$query, $filteredTerm, $fulltext)
	Get the base part of the search query.

	queryNamespaces (&$query)
	Add namespace conditions.

	regexTerm ( $string, $wildcard)

	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.

	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.

Public Member Functions inherited from SearchDatabase
	__construct (IDatabase $db=null)
	Constructor.

Public Member Functions inherited from SearchEngine
	augmentSearchResults (SearchResultSet $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.

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

	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.

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

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

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

	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.

	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.

	transformSearchTerm ( $term)
	Transform search term in cases when parts of the query came as different GET params (when supported), e.g.

Static Public Member Functions
static	legalSearchChars ( $type=self::CHARS_ALL)
	Get chars legal for search NOTE: usage as static is deprecated and preserved only as BC measure.

Static Public Member Functions inherited from SearchEngine
static	create ( $type=null)
	Load up the appropriate search engine class for the currently active database backend, and return a configured instance.

static	defaultNamespaces ()
	An array of namespaces indexes to be searched by default.

static	getNearMatch ( $searchterm)
	If an exact title match can be found, or a very slightly close match, return the title.

static	getNearMatchResultSet ( $searchterm)
	Do a near match (see SearchEngine::getNearMatch) and wrap it into a SearchResultSet.

static	getOpenSearchTemplate ()
	Get OpenSearch suggestion template.

static	getSearchTypes ()
	Return the search engines we support.

static	namespacesAsText ( $namespaces)
	Get a list of namespace names useful for showing in tooltips and preferences.

static	parseNamespacePrefixes ( $query)
	Parse some common prefixes: all (search everything) or namespace names.

static	searchableNamespaces ()
	Make a list of searchable namespaces and their canonical names.

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

static	userNamespaces ( $user)
	Extract default namespaces to search from the given user's settings, returning a list of index numbers.

Protected Member Functions
	limitResult (&$query)
	Add limit options.

	minSearchLength ()
	Check MySQL server's ft_min_word_len setting so we know if we need to pad short words...

	queryFeatures (&$query)
	Add special conditions.

	searchInternal ( $term, $fulltext)

	stripForSearchCallback ( $matches)
	Armor a case-folded UTF-8 string to get through MySQL's fulltext search without being mucked up by funny charset settings or anything else of the sort.

Protected Member Functions inherited from SearchDatabase
	filter ( $text)
	Return a 'cleaned up' search string.

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

	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
	$strictMatching = true

Protected Attributes inherited from SearchDatabase
IDatabase	$db
	Slave database for reading from for results.

Protected Attributes inherited from SearchEngine
array	$features = []
	Feature values.

int	$limit = 10

int	$offset = 0

array string	$searchTerms = []

bool	$showSuggestion = true

Static Private Attributes
static	$mMinSearchLength

Additional Inherited Members
Public Attributes inherited from SearchEngine
int[] null	$namespaces = [ NS_MAIN ]

string	$prefix = ''

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

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

const	COMPLETION_PROFILE_TYPE = 'completionSearchProfile'
	@const string profile type for completionSearch

const	FT_QUERY_INDEP_PROFILE_TYPE = 'fulltextQueryIndepProfile'
	@const string profile type for query independent ranking features

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

Detailed Description

Search engine hook for MySQL 4+.

Definition at line 31 of file SearchMySQL.php.

Member Function Documentation

◆ delete()

SearchMySQL::delete	(	$id,
		$title
	)

Delete an indexed page Title should be pre-processed.

Parameters

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

Reimplemented from SearchEngine.

Definition at line 375 of file SearchMySQL.php.

References $title, DB_MASTER, and wfGetDB().

◆ getCountQuery()

SearchMySQL::getCountQuery	(	$filteredTerm,
		$fulltext
	)

Since: 1.18 (changed)

Parameters

string	$filteredTerm
bool	$fulltext

Returns: array

Definition at line 315 of file SearchMySQL.php.

References $query, parseQuery(), queryFeatures(), and queryNamespaces().

Referenced by searchInternal().

◆ getIndexField()

SearchMySQL::getIndexField ( $fulltext )

Picks which field to index on, depending on what type of query.

Parameters

bool $fulltext

Returns: string

Definition at line 286 of file SearchMySQL.php.

Referenced by parseQuery().

◆ getQuery()

SearchMySQL::getQuery	(	$filteredTerm,
		$fulltext
	)

Construct the SQL query to do the search.

The guts shoulds be constructed in queryMain()

Parameters

string	$filteredTerm
bool	$fulltext

Returns: array

Since: 1.18 (changed)

Definition at line 264 of file SearchMySQL.php.

References $query, limitResult(), queryFeatures(), queryMain(), and queryNamespaces().

Referenced by searchInternal().

◆ legalSearchChars()

static SearchMySQL::legalSearchChars ( $type = self::CHARS_ALL )

static

Get chars legal for search NOTE: usage as static is deprecated and preserved only as BC measure.

Parameters

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

Returns: string

Reimplemented from SearchEngine.

Definition at line 152 of file SearchMySQL.php.

References $type.

Referenced by parseQuery().

◆ limitResult()

SearchMySQL::limitResult ( & $query )

protected

Add limit options.

Parameters

array $query

Since: 1.18

Definition at line 251 of file SearchMySQL.php.

References SearchEngine\$limit, SearchEngine\$offset, and $query.

Referenced by getQuery().

◆ minSearchLength()

SearchMySQL::minSearchLength ( )

protected

Check MySQL server's ft_min_word_len setting so we know if we need to pad short words...

Returns: int

Definition at line 441 of file SearchMySQL.php.

References $dbr, $mMinSearchLength, DB_REPLICA, and wfGetDB().

Referenced by normalizeText().

◆ normalizeText()

SearchMySQL::normalizeText ( $string )

Converts some characters for MySQL's indexing to grok it correctly, and pads short words to overcome limitations.

Parameters

string $string

Returns: mixed|string

Reimplemented from SearchEngine.

Definition at line 387 of file SearchMySQL.php.

References $out, $wgContLang, global, and minSearchLength().

Referenced by parseQuery(), update(), and updateTitle().

◆ parseQuery()

SearchMySQL::parseQuery	(	$filteredText,
		$fulltext
	)

Parse the user's query and transform it into an SQL fragment which will become part of a WHERE clause.

Parameters

string	$filteredText
string	$fulltext

Returns: string

Definition at line 45 of file SearchMySQL.php.

References $term, $wgContLang, as, getIndexField(), global, legalSearchChars(), list, normalizeText(), regexTerm(), and wfDebug().

Referenced by getCountQuery(), and queryMain().

◆ queryFeatures()

SearchMySQL::queryFeatures ( & $query )

protected

Add special conditions.

Parameters

array $query

Since: 1.18

Definition at line 224 of file SearchMySQL.php.

References $query, $value, and as.

Referenced by getCountQuery(), and getQuery().

◆ queryMain()

SearchMySQL::queryMain	(	&	$query,
			$filteredTerm,
			$fulltext
	)

Get the base part of the search query.

Parameters

array	&$query	Search query array
string	$filteredTerm
bool	$fulltext

Since: 1.18 (changed)

Definition at line 298 of file SearchMySQL.php.

References $query, and parseQuery().

Referenced by getQuery().

◆ queryNamespaces()

SearchMySQL::queryNamespaces ( & $query )

Add namespace conditions.

Parameters

array $query

Since: 1.18 (changed)

Definition at line 237 of file SearchMySQL.php.

References SearchEngine\$namespaces, $query, and namespaces.

Referenced by getCountQuery(), and getQuery().

◆ regexTerm()

SearchMySQL::regexTerm	(	$string,
		$wildcard
	)

Definition at line 133 of file SearchMySQL.php.

References $wgContLang, and global.

Referenced by parseQuery().

◆ searchInternal()

SearchMySQL::searchInternal	(	$term,
		$fulltext
	)

protected

Definition at line 181 of file SearchMySQL.php.

References $query, $term, SearchDatabase\filter(), getCountQuery(), and getQuery().

Referenced by searchText(), and searchTitle().

◆ searchText()

SearchMySQL::searchText ( $term )

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

Parameters

string $term Raw search term

Returns: SqlSearchResultSet

Reimplemented from SearchEngine.

Definition at line 167 of file SearchMySQL.php.

References $term, and searchInternal().

◆ searchTitle()

SearchMySQL::searchTitle ( $term )

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

Parameters

string $term Raw search term

Returns: SqlSearchResultSet

Reimplemented from SearchEngine.

Definition at line 177 of file SearchMySQL.php.

References $term, and searchInternal().

◆ stripForSearchCallback()

SearchMySQL::stripForSearchCallback ( $matches )

protected

Armor a case-folded UTF-8 string to get through MySQL's fulltext search without being mucked up by funny charset settings or anything else of the sort.

Parameters

array $matches

Returns: string

Definition at line 431 of file SearchMySQL.php.

References $matches.

◆ supports()

SearchMySQL::supports ( $feature )

Since: 1.18

Parameters

string $feature

Returns: bool

Reimplemented from SearchEngine.

Definition at line 210 of file SearchMySQL.php.

◆ update()

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

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

Title and text should be pre-processed.

Parameters

int	$id
string	$title
string	$text

Reimplemented from SearchEngine.

Definition at line 340 of file SearchMySQL.php.

References $title, DB_MASTER, normalizeText(), and wfGetDB().

◆ updateTitle()

SearchMySQL::updateTitle	(	$id,
		$title
	)

Update a search index record's title only.

Title should be pre-processed.

Parameters

int	$id
string	$title

Reimplemented from SearchEngine.

Definition at line 358 of file SearchMySQL.php.

References $title, DB_MASTER, normalizeText(), and wfGetDB().

Member Data Documentation

◆ $mMinSearchLength

SearchMySQL::$mMinSearchLength

staticprivate

Definition at line 34 of file SearchMySQL.php.

Referenced by minSearchLength().

◆ $strictMatching

SearchMySQL::$strictMatching = true

protected

Definition at line 32 of file SearchMySQL.php.

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

includes/search/SearchMySQL.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ delete()

◆ getCountQuery()

◆ getIndexField()

◆ getQuery()

◆ legalSearchChars()

◆ limitResult()

◆ minSearchLength()

◆ normalizeText()

◆ parseQuery()

◆ queryFeatures()

◆ queryMain()

◆ queryNamespaces()

◆ regexTerm()

◆ searchInternal()

◆ searchText()

◆ searchTitle()

◆ stripForSearchCallback()

◆ supports()

◆ update()

◆ updateTitle()

Member Data Documentation

◆ $mMinSearchLength

◆ $strictMatching