Search engine hook base class for Mssql (ConText). More...

Inheritance diagram for SearchMssql:

Collaboration diagram for SearchMssql:

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

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

	parseQuery ($filteredText, $fulltext)

	queryLimit ($sql)
	Return a LIMIT clause to limit results on the query. More...

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

	queryNamespaces ()
	Return a partial WHERE clause to limit the search to the given namespaces. More...

	queryRanking ($filteredTerm, $fulltext)
	Does not do anything for generic search engine subclasses may define this though. More...

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

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

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

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

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

Public Member Functions inherited from SearchEngine
	augmentSearchResults (SearchResultSet $resultSet)
	Augment search results with extra data. More...

	completionSearch ($search)
	Perform a completion search. More...

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

	defaultPrefixSearch ($search)
	Simple prefix search for subpages. More...

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

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

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

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

	getSearchIndexFields ()
	Get fields for search index. More...

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

	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. More...

	getValidSorts ()
	Get the valid sort directions. More...

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

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

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

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

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

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

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

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

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

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

	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. More...

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

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

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

Additional Inherited Members
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. More...

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

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

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

static	getOpenSearchTemplate ()
	Get OpenSearch suggestion template. More...

static	getSearchTypes ()
	Return the search engines we support. More...

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

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

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

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

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

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

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

string	$prefix = ''

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

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

const	COMPLETION_PROFILE_TYPE = 'completionSearchProfile'
	string profile type for completionSearch More...

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

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

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

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

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

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

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

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

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

int	$limit = 10

int	$offset = 0

array string	$searchTerms = []

bool	$showSuggestion = true

Detailed Description

Search engine hook base class for Mssql (ConText).

Definition at line 28 of file SearchMssql.php.

Member Function Documentation

SearchMssql::getIndexField ( $fulltext )

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

Parameters

bool $fulltext

Returns: string

Definition at line 110 of file SearchMssql.php.

Referenced by parseQuery().

SearchMssql::getQuery	(	$filteredTerm,
		$fulltext
	)

Construct the full SQL query to do the search.

The guts shoulds be constructed in queryMain()

Parameters

string	$filteredTerm
bool	$fulltext

Returns: string

Definition at line 98 of file SearchMssql.php.

References queryLimit(), queryMain(), queryNamespaces(), and queryRanking().

Referenced by searchText(), and searchTitle().

SearchMssql::parseQuery	(	$filteredText,
		$fulltext
	)

Todo:

document

Parameters

string	$filteredText
bool	$fulltext

Returns: string

Definition at line 137 of file SearchMssql.php.

References $wgContLang, as, getIndexField(), global, and SearchEngine\legalSearchChars().

Referenced by queryMain().

SearchMssql::queryLimit ( $sql )

Return a LIMIT clause to limit results on the query.

Parameters

string $sql

Returns: string

Definition at line 74 of file SearchMssql.php.

Referenced by getQuery().

SearchMssql::queryMain	(	$filteredTerm,
		$fulltext
	)

Get the base part of the search query.

Parameters

string	$filteredTerm
bool	$fulltext

Returns: string

Access:: private

Definition at line 122 of file SearchMssql.php.

References $page, and parseQuery().

Referenced by getQuery().

SearchMssql::queryNamespaces ( )

Return a partial WHERE clause to limit the search to the given namespaces.

Returns: string

Access:: private

Definition at line 59 of file SearchMssql.php.

References SearchEngine\$namespaces, and namespaces.

Referenced by getQuery().

SearchMssql::queryRanking	(	$filteredTerm,
		$fulltext
	)

Does not do anything for generic search engine subclasses may define this though.

Parameters

string	$filteredTerm
bool	$fulltext

Returns: string

Definition at line 86 of file SearchMssql.php.

Referenced by getQuery().

SearchMssql::searchText ( $term )

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

Parameters

string $term Raw search term

Returns: SqlSearchResultSet

Access:: public

Definition at line 36 of file SearchMssql.php.

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

SearchMssql::searchTitle ( $term )

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

Parameters

string $term Raw search term

Returns: SqlSearchResultSet

Access:: public

Definition at line 48 of file SearchMssql.php.

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

SearchMssql::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

Returns: bool|ResultWrapper

Definition at line 177 of file SearchMssql.php.

References $title.

SearchMssql::updateTitle	(	$id,
		$title
	)

Update a search index record's title only.

Title should be pre-processed.

Parameters

int	$id
string	$title

Returns: bool|ResultWrapper

Definition at line 200 of file SearchMssql.php.

References $title.

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

includes/search/SearchMssql.php

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation