implements Special:Search - Run text & title search and display the output More...

Inheritance diagram for SpecialSearch:

Collaboration diagram for SpecialSearch:

Public Member Functions
	__construct ()
	execute ($par)
	Entry point.
	getNamespaces ()
	getProfile ()
	getSearchEngine ()
	goResult ($term)
	If an exact title match can be found, jump straight ahead to it.
	load ()
	Set up basic search parameters from the request and user settings.
	setExtraParam ($key, $value)
	Users of hook SpecialSearchSetupEngine can use this to add more params to links to not lose selection when user navigates search results.
	showResults ($term)
Public Attributes
string	$fulltext
int	$offset
const	NAMESPACES_CURRENT = 'sense'
Protected Member Functions
	formHeader ($term, $resultsShown, $totalNum)
	getProfileForm ($profile, $term)
	getSearchProfiles ()
	makeSearchLink ($term, $namespaces, $label, $tooltip, $params=array())
	Make a search link with some target namespaces.
	powerSearch (&$request)
	Extract "power search" namespace settings from the request object, returning a list of index numbers to search.
	powerSearchBox ($term, $opts)
	Generates the power search box at [[Special:Search]].
	powerSearchOptions ()
	Reconstruct the 'power search' options for links.
	setupPage ($term)
	shortDialog ($term)
	showCreateLink ($t)
	showHit ($result, $terms)
	Format a single hit result.
	showInterwiki (&$matches, $query)
	Show results from other wikis.
	showInterwikiHit ($result, $lastInterwiki, $terms, $query, $customCaptions)
	Show single interwiki link.
	showMatches (&$matches)
	Show whole set of results.
	startsWithAll ($term)
	Check if query starts with all: prefix.
	startsWithImage ($term)
	Check if query starts with image: prefix.
Protected Attributes
string	$didYouMeanHtml
	$extraParams = array()
	For links.
int	$limit
	$mPrefix
	No idea, apparently used by some other classes.
array	$namespaces
	$profile
	Current search profile.
	$searchEngine
	Search engine.
bool	$searchRedirects

Detailed Description

implements Special:Search - Run text & title search and display the output

Definition at line 30 of file SpecialSearch.php.

Constructor & Destructor Documentation

SpecialSearch::__construct ( )

Definition at line 70 of file SpecialSearch.php.

Member Function Documentation

SpecialSearch::execute ( $ par )

Entry point.

Parameters:

$par	String or null

Reimplemented from SpecialPage.

Definition at line 79 of file SpecialSearch.php.

SpecialSearch::formHeader	(	$	term,
		$	resultsShown,
		$	totalNum
	)		`[protected]`

Parameters:

$term
$resultsShown
$totalNum

Returns:: string

Definition at line 962 of file SpecialSearch.php.

Referenced by showResults().

SpecialSearch::getNamespaces ( )

Definition at line 58 of file SpecialSearch.php.

SpecialSearch::getProfile ( )

Definition at line 40 of file SpecialSearch.php.

SpecialSearch::getProfileForm	(	$	profile,
		$	term
	)		`[protected]`

Parameters:

$profile
$term

Returns:: String

Definition at line 812 of file SpecialSearch.php.

Referenced by showResults().

SpecialSearch::getSearchEngine ( )

Since:: 1.18

Returns:: SearchEngine

Definition at line 1120 of file SpecialSearch.php.

Referenced by showResults().

SpecialSearch::getSearchProfiles ( ) [protected]

Returns:: array

Definition at line 908 of file SpecialSearch.php.

References SearchEngine\defaultNamespaces(), SearchEngine\helpNamespaces(), SearchEngine\namespacesAsText(), SearchEngine\searchableNamespaces(), and wfRunHooks().

SpecialSearch::goResult ( $ term )

If an exact title match can be found, jump straight ahead to it.

Parameters:

$term String

Definition at line 167 of file SpecialSearch.php.

SpecialSearch::load ( )

Set up basic search parameters from the request and user settings.

See also:: tests/phpunit/includes/specials/SpecialSearchTest.php

Definition at line 112 of file SpecialSearch.php.

SpecialSearch::makeSearchLink	(	$	term,
		$	namespaces,
		$	label,
		$	tooltip,
		$	params = `array()`
	)		`[protected]`

Make a search link with some target namespaces.

Parameters:

$term	String
$namespaces	Array ignored
$label	String: link's text
$tooltip	String: link's tooltip
$params	Array: query string parameters

Returns:: String: HTML fragment

Definition at line 1058 of file SpecialSearch.php.

SpecialSearch::powerSearch ( &$ request ) [protected]

Extract "power search" namespace settings from the request object, returning a list of index numbers to search.

Parameters:

$request WebRequest

Returns:: Array

Definition at line 461 of file SpecialSearch.php.

SpecialSearch::powerSearchBox	(	$	term,
		$	opts
	)		`[protected]`

Generates the power search box at [[Special:Search]].

Parameters:

$term	String: search term
$opts	array

Returns:: String: HTML form

Definition at line 834 of file SpecialSearch.php.

SpecialSearch::powerSearchOptions ( ) [protected]

Reconstruct the 'power search' options for links.

Returns:: Array

Definition at line 477 of file SpecialSearch.php.

Referenced by showResults().

SpecialSearch::setExtraParam	(	$	key,
		$	value
	)

Users of hook SpecialSearchSetupEngine can use this to add more params to links to not lose selection when user navigates search results.

Since:: 1.18

Parameters:

$key
$value

Definition at line 1136 of file SpecialSearch.php.

SpecialSearch::setupPage ( $ term ) [protected]

Parameters:

$term string

Definition at line 442 of file SpecialSearch.php.

References $out, SpecialPage\getOutput(), and SpecialPage\msg().

Referenced by showResults().

SpecialSearch::shortDialog ( $ term ) [protected]

Parameters:

$term string

Returns:: string

Definition at line 1034 of file SpecialSearch.php.

Referenced by showResults().

SpecialSearch::showCreateLink ( $ t ) [protected]

Parameters:

$t Title

Definition at line 409 of file SpecialSearch.php.

References $params, $t, SpecialPage\getOutput(), wfEscapeWikiText(), and wfRunHooks().

Referenced by showResults().

SpecialSearch::showHit	(	$	result,
		$	terms
	)		`[protected]`

Format a single hit result.

Parameters:

$result	SearchResult
$terms	Array: terms to highlight

Returns:: string

Definition at line 530 of file SpecialSearch.php.

SpecialSearch::showInterwiki	(	&$	matches,
		$	query
	)		`[protected]`

Show results from other wikis.

Parameters:

$matches	SearchResultSet
$query	String

Returns:: string

Definition at line 696 of file SpecialSearch.php.

Referenced by showResults().

SpecialSearch::showInterwikiHit	(	$	result,
		$	lastInterwiki,
		$	terms,
		$	query,
		$	customCaptions
	)		`[protected]`

Show single interwiki link.

Parameters:

$result	SearchResult
$lastInterwiki	String
$terms	Array
$query	String
$customCaptions	Array: iw prefix -> caption

Returns:: string

Definition at line 741 of file SpecialSearch.php.

SpecialSearch::showMatches ( &$ matches ) [protected]

Show whole set of results.

Parameters:

$matches SearchResultSet

Returns:: string

Definition at line 497 of file SpecialSearch.php.

Referenced by showResults().

SpecialSearch::showResults ( $ term )

Parameters:

$term String

Definition at line 207 of file SpecialSearch.php.

References $out, $t, $url, $wgContLang, Xml\closeElement(), Xml\element(), formHeader(), SpecialPage\getLanguage(), SpecialPage\getOutput(), getProfileForm(), getSearchEngine(), SpecialPage\getTitle(), SpecialPage\getTitleFor(), Linker\linkKnown(), SpecialPage\msg(), Title\newFromText(), Xml\openElement(), powerSearchOptions(), setupPage(), shortDialog(), showCreateLink(), showInterwiki(), showMatches(), wfEscapeWikiText(), wfProfileIn(), wfProfileOut(), and wfRunHooks().

SpecialSearch::startsWithAll ( $ term ) [protected]

Check if query starts with all: prefix.

Parameters:

$term String: the string to check

Returns:: Boolean

Definition at line 1104 of file SpecialSearch.php.

SpecialSearch::startsWithImage ( $ term ) [protected]

Check if query starts with image: prefix.

Parameters:

$term String: the string to check

Returns:: Boolean

Definition at line 1088 of file SpecialSearch.php.

Member Data Documentation

string SpecialSearch::$didYouMeanHtml [protected]

Definition at line 66 of file SpecialSearch.php.

SpecialSearch::$extraParams = array() [protected]

For links.

Definition at line 46 of file SpecialSearch.php.

string SpecialSearch::$fulltext

Definition at line 66 of file SpecialSearch.php.

int SpecialSearch::$limit [protected]

Definition at line 53 of file SpecialSearch.php.

SpecialSearch::$mPrefix [protected]

No idea, apparently used by some other classes.

Definition at line 49 of file SpecialSearch.php.

array SpecialSearch::$namespaces [protected]

Definition at line 57 of file SpecialSearch.php.

int SpecialSearch::$offset

Definition at line 53 of file SpecialSearch.php.

SpecialSearch::$profile [protected]

Current search profile.

Search profile is just a name that identifies the active search tab on the search page (content, help, discussions...) For users tt replaces the set of enabled namespaces from the query string when applicable. Extensions can add new profiles with hooks with custom search options just for that profile. null|string

Definition at line 39 of file SpecialSearch.php.

SpecialSearch::$searchEngine [protected]

Search engine.

Definition at line 43 of file SpecialSearch.php.

bool SpecialSearch::$searchRedirects [protected]

Definition at line 62 of file SpecialSearch.php.

const SpecialSearch::NAMESPACES_CURRENT = 'sense'

Definition at line 68 of file SpecialSearch.php.

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

includes/specials/SpecialSearch.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation