Search engine hook for SQLite. More...

Inheritance diagram for SearchSqlite:

Collaboration diagram for SearchSqlite:

[legend]

Public Member Functions
	fulltextSearchSupported ()
	Whether fulltext search is supported by current schema. More...

	getCountQuery ( $filteredTerm, $fulltext)

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

	limitResult ( $sql)
	Returns a query with limit for number of results set. More...

	parseQuery ( $filteredText, $fulltext)
	Parse the user's query and transform it into an SQL fragment which will become part of a WHERE clause. 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...

	regexTerm ( $string, $wildcard)

	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 (DatabaseBase $db=null)
	Constructor. More...

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

	filter ( $text)
	Return a 'cleaned up' search string. 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...

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

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

Static Public Member Functions
static	legalSearchChars ()

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	helpNamespaces ()
	Return the help namespaces to be shown on Special:Search. More...

static	namespacesAsText ( $namespaces)
	Get a list of namespace names useful for showing in tooltips and preferences. 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...

Protected Member Functions
	searchInternal ( $term, $fulltext)

Additional Inherited Members
Public Attributes inherited from SearchEngine
	$limit = 10

	$namespaces = array( NS_MAIN )

	$offset = 0

	$prefix = ''

	$searchTerms = array()

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

Protected Attributes inherited from SearchEngine
Array	$features = array()
	Feature values *. More...

	$showSuggestion = true

Detailed Description

Search engine hook for SQLite.

Definition at line 28 of file SearchSqlite.php.

Member Function Documentation

◆ fulltextSearchSupported()

SearchSqlite::fulltextSearchSupported ( )

Whether fulltext search is supported by current schema.

Returns: Boolean

Definition at line 33 of file SearchSqlite.php.

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

◆ getCountQuery()

SearchSqlite::getCountQuery	(	$filteredTerm,
		$fulltext
	)

Definition at line 251 of file SearchSqlite.php.

References parseQuery(), and queryNamespaces().

Referenced by searchInternal().

◆ getIndexField()

SearchSqlite::getIndexField ( $fulltext )

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

Parameters

$fulltext Boolean

Returns: String

Definition at line 231 of file SearchSqlite.php.

Referenced by parseQuery().

◆ getQuery()

SearchSqlite::getQuery	(	$filteredTerm,
		$fulltext
	)

Construct the full SQL query to do the search.

The guts shoulds be constructed in queryMain()

Parameters

$filteredTerm	String
$fulltext	Boolean

Returns: String

Definition at line 219 of file SearchSqlite.php.

References limitResult(), queryMain(), and queryNamespaces().

Referenced by searchInternal().

◆ legalSearchChars()

static SearchSqlite::legalSearchChars ( )

static

Reimplemented from SearchEngine.

Definition at line 140 of file SearchSqlite.php.

◆ limitResult()

SearchSqlite::limitResult ( $sql )

Returns a query with limit for number of results set.

Parameters

$sql String:

Returns: String

Definition at line 208 of file SearchSqlite.php.

Referenced by getQuery().

◆ parseQuery()

SearchSqlite::parseQuery	(	$filteredText,
		$fulltext
	)

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

Returns: string

Definition at line 43 of file SearchSqlite.php.

References $regexp, $term, $wgContLang, array(), as, getIndexField(), global, SearchEngine\legalSearchChars(), list, regexTerm(), and wfDebug().

Referenced by getCountQuery(), and queryMain().

◆ queryMain()

SearchSqlite::queryMain	(	$filteredTerm,
		$fulltext
	)

Get the base part of the search query.

Parameters

$filteredTerm	String
$fulltext	Boolean

Returns: String

Definition at line 242 of file SearchSqlite.php.

References parseQuery().

Referenced by getQuery().

◆ queryNamespaces()

SearchSqlite::queryNamespaces ( )

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

Returns: String

Definition at line 191 of file SearchSqlite.php.

References SearchEngine\$namespaces, and namespaces.

Referenced by getCountQuery(), and getQuery().

◆ regexTerm()

SearchSqlite::regexTerm	(	$string,
		$wildcard
	)

Definition at line 121 of file SearchSqlite.php.

References $wgContLang, and global.

Referenced by parseQuery().

◆ searchInternal()

SearchSqlite::searchInternal	(	$term,
		$fulltext
	)

protected

Definition at line 164 of file SearchSqlite.php.

References $term, $total, $wgContLang, SearchEngine\filter(), fulltextSearchSupported(), getCountQuery(), getQuery(), and global.

Referenced by searchText(), and searchTitle().

◆ searchText()

SearchSqlite::searchText ( $term )

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

Parameters

string $term raw search term

Returns: SqliteSearchResultSet

Reimplemented from SearchEngine.

Definition at line 150 of file SearchSqlite.php.

References $term, and searchInternal().

◆ searchTitle()

SearchSqlite::searchTitle ( $term )

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

Parameters

string $term raw search term

Returns: SqliteSearchResultSet

Reimplemented from SearchEngine.

Definition at line 160 of file SearchSqlite.php.

References $term, and searchInternal().

◆ update()

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

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

Title and text should be pre-processed.

Parameters

$id	Integer
$title	String
$text	String

Reimplemented from SearchEngine.

Definition at line 269 of file SearchSqlite.php.

References $title, array(), DB_MASTER, fulltextSearchSupported(), and wfGetDB().

◆ updateTitle()

SearchSqlite::updateTitle	(	$id,
		$title
	)

Update a search index record's title only.

Title should be pre-processed.

Parameters

$id	Integer
$title	String

Reimplemented from SearchEngine.

Definition at line 294 of file SearchSqlite.php.

References $title, array(), DB_MASTER, fulltextSearchSupported(), and wfGetDB().

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

includes/search/SearchSqlite.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ fulltextSearchSupported()

◆ getCountQuery()

◆ getIndexField()

◆ getQuery()

◆ legalSearchChars()

◆ limitResult()

◆ parseQuery()

◆ queryMain()

◆ queryNamespaces()

◆ regexTerm()

◆ searchInternal()

◆ searchText()

◆ searchTitle()

◆ update()

◆ updateTitle()