Contain a class for special pages. More...

Inheritance diagram for SearchEngine:

Collaboration diagram for SearchEngine:

Public Member Functions
	delete ($id, $title)
	Delete an indexed page Title should be pre-processed.
	filter ($text)
	Return a 'cleaned up' search string.
	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.
	normalizeText ($string)
	When overridden in derived class, performs database-specific conversions on text to be used for searching or updating search index.
	replacePrefixes ($query)
	Parse some common prefixes: all (search everything) or namespace names.
	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.
	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.
	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.
	transformSearchTerm ($term)
	Transform search term in cases when parts of the query came as different GET params (when supported) e.g.
	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.
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.
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	helpNamespaces ()
	Return the help namespaces to be shown on Special:Search.
static	legalSearchChars ()
static	namespacesAsText ($namespaces)
	Get a list of namespace names useful for showing in tooltips and preferences.
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.
Public Attributes
	$limit = 10
	$namespaces = array( NS_MAIN )
	$offset = 0
	$prefix = ''
	$searchTerms = array()
Protected Attributes
Array	$features = array()
	Feature values *.
	$showSuggestion = true
Static Private Member Functions
static	getNearMatchInternal ($searchterm)
	Really find the title match.

Detailed Description

Contain a class for special pages.

Definition at line 32 of file SearchEngine.php.

Member Function Documentation

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.

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

static SearchEngine::defaultNamespaces ( ) [static]

An array of namespaces indexes to be searched by default.

Returns:: Array

Definition at line 393 of file SearchEngine.php.

Referenced by SpecialSearchTest\provideSearchOptionsTests().

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.

SearchEngine::filter ( $ text )

Return a 'cleaned up' search string.

Parameters:

$text String

Returns:: String

Definition at line 435 of file SearchEngine.php.

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

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.

static SearchEngine::getNearMatchInternal ( $ searchterm ) [static, private]

Really find the title match.

Returns:: null|Title

Definition at line 144 of file SearchEngine.php.

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

static SearchEngine::getOpenSearchTemplate ( ) [static]

Get OpenSearch suggestion template.

Returns:: String

Definition at line 523 of file SearchEngine.php.

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.

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

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.

static SearchEngine::helpNamespaces ( ) [static]

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

Returns:: Array

Definition at line 423 of file SearchEngine.php.

static SearchEngine::legalSearchChars ( ) [static]

Reimplemented in SearchOracle, SearchMySQL, and SearchSqlite.

Definition at line 256 of file SearchEngine.php.

Referenced by Title\indexTitle(), and SearchMssql\parseQuery().

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.

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.

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.

static SearchEngine::searchableNamespaces ( ) [static]

Make a list of searchable namespaces and their canonical names.

Returns:: Array

Definition at line 334 of file SearchEngine.php.

Referenced by Preferences\loadOldSearchNs(), SpecialSearch\powerSearch(), and SpecialSearch\powerSearchBox().

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.

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.

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.

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.

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.

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.

SearchEngine::supports ( $ feature )

Since:: 1.18

Parameters:

$feature String

Returns:: Boolean

Reimplemented in SearchMySQL.

Definition at line 71 of file SearchEngine.php.

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.

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.

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 SearchMySQL, SearchSqlite, SearchOracle, SearchPostgres, SearchMssql, and MockSearch.

Definition at line 490 of file SearchEngine.php.

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.

static SearchEngine::userHighlightPrefs ( ) [static]

Find snippet highlight settings for all users.

Returns:: Array contextlines, contextchars

Definition at line 382 of file SearchEngine.php.

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.

Member Data Documentation

Array SearchEngine::$features = array() [protected]

Feature values *.

Definition at line 40 of file SearchEngine.php.

SearchEngine::$limit = 10

Definition at line 33 of file SearchEngine.php.

SearchEngine::$namespaces = array( NS_MAIN )

Definition at line 37 of file SearchEngine.php.

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

SearchEngine::$offset = 0

Definition at line 34 of file SearchEngine.php.

SearchEngine::$prefix = ''

Definition at line 35 of file SearchEngine.php.

SearchEngine::$searchTerms = array()

Definition at line 36 of file SearchEngine.php.

SearchEngine::$showSuggestion = true [protected]

Definition at line 38 of file SearchEngine.php.

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

Member Data Documentation