Contain a class for special pages. More...

Inheritance diagram for SearchEngine:

[legend]

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

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

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

Static Public Member Functions
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	legalSearchChars ()

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

Public Attributes
	$limit = 10

	$namespaces = array( NS_MAIN )

	$offset = 0

	$prefix = ''

	$searchTerms = array()

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

	$showSuggestion = true

Static Private Member Functions
static	getNearMatchInternal ( $searchterm)
	Really find the title match. More...

Detailed Description

Contain a class for special pages.

Definition at line 32 of file SearchEngine.php.

Member Function Documentation

◆ create()

static SearchEngine::create ( $type = null )

static

Load up the appropriate search engine class for the currently active database backend, and return a configured instance.

Parameters

String $type Type of search backend, if not the default

Returns: SearchEngine

Definition at line 447 of file SearchEngine.php.

References $dbr, $type, DB_SLAVE, getSearchTypes(), global, and wfGetDB().

Referenced by SpecialSearch\getSearchEngine(), SearchResult\initText(), and ApiQuerySearch\run().

◆ defaultNamespaces()

static SearchEngine::defaultNamespaces ( )

static

An array of namespaces indexes to be searched by default.

Returns: Array

Definition at line 393 of file SearchEngine.php.

References global.

Referenced by getOpenSearchTemplate(), SpecialSearch\getSearchProfiles(), and SpecialSearchTest\provideSearchOptionsTests().

◆ delete()

SearchEngine::delete	(	$id,
		$title
	)

Delete an indexed page Title should be pre-processed.

STUB

Parameters

Integer	$id	Page id that was deleted
String	$title	Title of page that was deleted

Reimplemented in SearchMySQL.

Definition at line 514 of file SearchEngine.php.

◆ filter()

SearchEngine::filter ( $text )

Return a 'cleaned up' search string.

Parameters

$text String

Returns: String

Definition at line 435 of file SearchEngine.php.

References legalSearchChars().

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

◆ getNearMatch()

static SearchEngine::getNearMatch ( $searchterm )

static

If an exact title match can be found, or a very slightly close match, return the title.

If no match, returns NULL.

Parameters

$searchterm String

Returns: Title

Definition at line 122 of file SearchEngine.php.

References $title, array(), getNearMatchInternal(), and wfRunHooks().

Referenced by getNearMatchInternal(), and SpecialSearch\goResult().

◆ getNearMatchInternal()

static SearchEngine::getNearMatchInternal ( $searchterm )

staticprivate

Really find the title match.

Returns: null|Title

Definition at line 144 of file SearchEngine.php.

References $matches, $term, $title, $wgContLang, array(), as, WikiPage\factory(), getNearMatch(), SpecialPage\getTitleFor(), global, User\isIP(), Title\makeTitle(), Title\newFromText(), NS_FILE, NS_MEDIA, NS_MEDIAWIKI, NS_USER, wfFindFile(), and wfRunHooks().

Referenced by getNearMatch().

◆ getNearMatchResultSet()

static SearchEngine::getNearMatchResultSet ( $searchterm )

static

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

Parameters

$searchterm string

Returns: SearchResultSet

Definition at line 136 of file SearchEngine.php.

Referenced by ApiQuerySearch\run().

◆ getOpenSearchTemplate()

static SearchEngine::getOpenSearchTemplate ( )

static

Get OpenSearch suggestion template.

Returns: String

Definition at line 523 of file SearchEngine.php.

References defaultNamespaces(), global, and wfScript().

◆ getSearchTypes()

static SearchEngine::getSearchTypes ( )

static

Return the search engines we support.

If only $wgSearchType is set, it'll be an array of just that one item.

Returns: array

Definition at line 472 of file SearchEngine.php.

References array(), and global.

Referenced by create(), ApiQuerySearch\getAllowedParams(), and ApiQuerySearch\getParamDescription().

◆ getTextFromContent()

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

Todo:: This isn't ideal, we'd really like to have content-specific handling here

Parameters

Title	$t	Title we're indexing
Content	$c	Content of the page to index

Returns: string

Definition at line 546 of file SearchEngine.php.

◆ helpNamespaces()

static SearchEngine::helpNamespaces ( )

static

Return the help namespaces to be shown on Special:Search.

Returns: Array

Definition at line 423 of file SearchEngine.php.

References global.

Referenced by SpecialSearch\getSearchProfiles().

◆ legalSearchChars()

static SearchEngine::legalSearchChars ( )

static

Reimplemented in SearchOracle, SearchMySQL, and SearchSqlite.

Definition at line 256 of file SearchEngine.php.

Referenced by filter(), Title\indexTitle(), SearchSqlite\parseQuery(), SearchMySQL\parseQuery(), SearchMssql\parseQuery(), and SearchOracle\parseQuery().

◆ namespacesAsText()

static SearchEngine::namespacesAsText ( $namespaces )

static

Get a list of namespace names useful for showing in tooltips and preferences.

Parameters

$namespaces Array

Returns: array

Definition at line 406 of file SearchEngine.php.

References $namespaces, $wgContLang, array(), as, global, and wfMessage().

Referenced by SpecialSearch\getSearchProfiles().

◆ normalizeText()

SearchEngine::normalizeText ( $string )

When overridden in derived class, performs database-specific conversions on text to be used for searching or updating search index.

Default implementation does nothing (simply returns $string).

Parameters

string $string String to process

Returns: string

Reimplemented in SearchMySQL.

Definition at line 100 of file SearchEngine.php.

References $wgContLang, and global.

◆ replacePrefixes()

SearchEngine::replacePrefixes ( $query )

Parse some common prefixes: all (search everything) or namespace names.

Parameters

$query String

Returns: string

Definition at line 300 of file SearchEngine.php.

References $prefix, $query, $wgContLang, array(), global, namespaces, wfMessage(), and wfRunHooks().

◆ searchableNamespaces()

static SearchEngine::searchableNamespaces ( )

static

Make a list of searchable namespaces and their canonical names.

Returns: Array

Definition at line 334 of file SearchEngine.php.

References $name, $wgContLang, array(), as, global, NS_MAIN, and wfRunHooks().

Referenced by User\getDefaultOptions(), SpecialSearch\getSearchProfiles(), Preferences\loadOldSearchNs(), SpecialSearch\powerSearch(), SpecialSearch\powerSearchBox(), and userNamespaces().

◆ searchText()

SearchEngine::searchText ( $term )

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

If title searches are not supported or disabled, return null. STUB

Parameters

string $term raw search term

Returns: SearchResultSet|Status|null

Reimplemented in SearchMySQL, SearchSqlite, SearchOracle, SearchPostgres, and SearchMssql.

Definition at line 50 of file SearchEngine.php.

◆ searchTitle()

SearchEngine::searchTitle ( $term )

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

If title searches are not supported or disabled, return null. STUB

Parameters

string $term raw search term

Returns: SearchResultSet|null

Reimplemented in SearchMySQL, SearchSqlite, SearchOracle, SearchMssql, and SearchPostgres.

Definition at line 62 of file SearchEngine.php.

◆ setFeatureData()

SearchEngine::setFeatureData	(	$feature,
		$data
	)

Way to pass custom data for engines.

Since: 1.18

Parameters

$feature	String
$data	Mixed

Returns: bool

Definition at line 88 of file SearchEngine.php.

◆ setLimitOffset()

SearchEngine::setLimitOffset	(	$limit,
		$offset = `0`
	)

Set the maximum number of results to return and how many to skip before returning the first.

Parameters

$limit	Integer
$offset	Integer

Definition at line 267 of file SearchEngine.php.

References $limit, and $offset.

◆ setNamespaces()

SearchEngine::setNamespaces ( $namespaces )

Set which namespaces the search should include.

Give an array of namespace index numbers.

Parameters

$namespaces Array

Definition at line 278 of file SearchEngine.php.

References $namespaces, and namespaces.

◆ setShowSuggestion()

SearchEngine::setShowSuggestion ( $showSuggestion )

Set whether the searcher should try to build a suggestion.

Note: some searchers don't support building a suggestion in the first place and others don't respect this flag.

Parameters

boolean $showSuggestion should the searcher try to build suggestions

Definition at line 289 of file SearchEngine.php.

References $showSuggestion.

◆ supports()

SearchEngine::supports ( $feature )

Since: 1.18

Parameters

$feature String

Returns: Boolean

Reimplemented in SearchMySQL.

Definition at line 71 of file SearchEngine.php.

◆ textAlreadyUpdatedForIndex()

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

Returns: bool

Definition at line 557 of file SearchEngine.php.

◆ transformSearchTerm()

SearchEngine::transformSearchTerm ( $term )

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

for prefix queries: search=test&prefix=Main_Page/Archive -> test prefix:Main Page/Archive

Definition at line 111 of file SearchEngine.php.

References $term.

◆ update()

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

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

Title and text should be pre-processed. STUB

Parameters

$id	Integer
$title	String
$text	String

Reimplemented in SearchPostgres, SearchMySQL, SearchSqlite, SearchOracle, SearchMssql, and MockSearch.

Definition at line 490 of file SearchEngine.php.

◆ updateTitle()

SearchEngine::updateTitle	(	$id,
		$title
	)

Update a search index record's title only.

Title should be pre-processed. STUB

Parameters

$id	Integer
$title	String

Reimplemented in SearchMySQL, SearchSqlite, SearchOracle, SearchPostgres, and SearchMssql.

Definition at line 502 of file SearchEngine.php.

◆ userHighlightPrefs()

static SearchEngine::userHighlightPrefs ( )

static

Find snippet highlight settings for all users.

Returns: Array contextlines, contextchars

Definition at line 382 of file SearchEngine.php.

References array().

Referenced by SearchResult\getTextSnippet().

◆ userNamespaces()

static SearchEngine::userNamespaces ( $user )

static

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

Parameters

$user User

Returns: Array

Definition at line 354 of file SearchEngine.php.

References $name, $user, array(), as, global, and searchableNamespaces().

Referenced by SpecialSearch\load().

Member Data Documentation

◆ $features

Array SearchEngine::$features = array()

protected

Feature values *.

Definition at line 40 of file SearchEngine.php.

◆ $limit

SearchEngine::$limit = 10

Definition at line 33 of file SearchEngine.php.

Referenced by SearchMySQL\limitResult(), and setLimitOffset().

◆ $namespaces

SearchEngine::$namespaces = array( NS_MAIN )

Definition at line 37 of file SearchEngine.php.

Referenced by namespacesAsText(), SearchMssql\queryNamespaces(), SearchOracle\queryNamespaces(), SearchSqlite\queryNamespaces(), SearchMySQL\queryNamespaces(), SearchPostgres\searchQuery(), and setNamespaces().

◆ $offset

SearchEngine::$offset = 0

Definition at line 34 of file SearchEngine.php.

Referenced by SearchMySQL\limitResult(), and setLimitOffset().

◆ $prefix

SearchEngine::$prefix = ''

Definition at line 35 of file SearchEngine.php.

Referenced by replacePrefixes().

◆ $searchTerms

SearchEngine::$searchTerms = array()

Definition at line 36 of file SearchEngine.php.

◆ $showSuggestion

SearchEngine::$showSuggestion = true

protected

Definition at line 38 of file SearchEngine.php.

Referenced by setShowSuggestion().

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

includes/search/SearchEngine.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Static Private Member Functions

Detailed Description

Member Function Documentation

◆ create()

◆ defaultNamespaces()

◆ delete()

◆ filter()

◆ getNearMatch()

◆ getNearMatchInternal()

◆ getNearMatchResultSet()

◆ getOpenSearchTemplate()

◆ getSearchTypes()

◆ getTextFromContent()

◆ helpNamespaces()

◆ legalSearchChars()

◆ namespacesAsText()

◆ normalizeText()

◆ replacePrefixes()

◆ searchableNamespaces()

◆ searchText()

◆ searchTitle()

◆ setFeatureData()

◆ setLimitOffset()

◆ setNamespaces()

◆ setShowSuggestion()

◆ supports()

◆ textAlreadyUpdatedForIndex()

◆ transformSearchTerm()

◆ update()

◆ updateTitle()

◆ userHighlightPrefs()

◆ userNamespaces()

Member Data Documentation

◆ $features

◆ $limit

◆ $namespaces

◆ $offset

◆ $prefix

◆ $searchTerms

◆ $showSuggestion