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

	getNamespaces ()
	Current namespaces. More...

	getProfile ()
	Current search profile. More...

	getSearchEngine ()

	goResult ($term)
	If an exact title match can be found, jump straight ahead to it. More...

	load ()
	Set up basic search parameters from the request and user settings. More...

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

	showResults ($term)

Public Member Functions inherited from SpecialPage
	__construct ($name= '', $restriction= '', $listed=true, $function=false, $file= '', $includable=false)
	Default constructor for special pages Derivative classes should call this from their constructor Note that if the user does not have the required level, an error message will be displayed by the default execute() method, without the global function ever being called. More...

	addHelpLink ($to, $overrideBaseUrl=false)
	Adds help link with an icon via page indicators. More...

	checkPermissions ()
	Checks if userCanExecute, and if not throws a PermissionsError. More...

	checkReadOnly ()
	If the wiki is currently in readonly mode, throws a ReadOnlyError. More...

	displayRestrictionError ()
	Output an error message telling the user what access level they have to have. More...

	doesWrites ()
	Indicates whether this special page may perform database writes. More...

	execute ($subPage)
	Default execute method Checks user permissions. More...

	getConfig ()
	Shortcut to get main config object. More...

	getContext ()
	Gets the context this SpecialPage is executed in. More...

	getDescription ()
	Returns the name that goes in the \<h1\> in the special page itself, and also the name that will be listed in Special:Specialpages. More...

	getFinalGroupName ()
	Get the group that the special page belongs in on Special:SpecialPage Use this method, instead of getGroupName to allow customization of the group name from the wiki side. More...

	getFullTitle ()
	Return the full title, including $par. More...

	getLanguage ()
	Shortcut to get user's language. More...

	getLocalName ()
	Get the localised name of the special page. More...

	getName ()
	Get the name of this Special Page. More...

	getOutput ()
	Get the OutputPage being used for this instance. More...

	getPageTitle ($subpage=false)
	Get a self-referential title object. More...

	getRequest ()
	Get the WebRequest being used for this instance. More...

	getRestriction ()
	Get the permission that a user must have to execute this page. More...

	getSkin ()
	Shortcut to get the skin being used for this instance. More...

	getTitle ($subpage=false)
	Get a self-referential title object. More...

	getUser ()
	Shortcut to get the User executing this instance. More...

	including ($x=null)
	Whether the special page is being evaluated via transclusion. More...

	isCached ()
	Is this page cached? Expensive pages are cached or disabled in miser mode. More...

	isExpensive ()
	Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode. More...

	isIncludable ()
	Whether it's allowed to transclude the special page via {{Special:Foo/params}}. More...

	isListed ()
	Whether this special page is listed in Special:SpecialPages. More...

	isRestricted ()
	Can be overridden by subclasses with more complicated permissions schemes. More...

	listed ($x=null)
	Get or set whether this special page is listed in Special:SpecialPages. More...

	maxIncludeCacheTime ()
	How long to cache page when it is being included. More...

	msg ()
	Wrapper around wfMessage that sets the current context. More...

	outputHeader ($summaryMessageKey= '')
	Outputs a summary message on top of special pages Per default the message key is the canonical name of the special page May be overridden, i.e. More...

	prefixSearchSubpages ($search, $limit, $offset)
	Return an array of subpages beginning with $search that this special page will accept. More...

	requireLogin ($reasonMsg= 'exception-nologin-text', $titleMsg= 'exception-nologin')
	If the user is not logged in, throws UserNotLoggedIn error. More...

	run ($subPage)
	Entry point. More...

	setContext ($context)
	Sets the context this SpecialPage is executed in. More...

	setHeaders ()
	Sets headers - this should be called from the execute() method of all derived classes! More...

	setLinkRenderer (LinkRenderer $linkRenderer)

	setListed ($listed)
	Set whether this page is listed in Special:Specialpages, at run-time. More...

	userCanExecute (User $user)
	Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction). More...

Public Attributes
int	$offset

const	NAMESPACES_CURRENT = 'sense'

Protected Member Functions
	getCustomCaptions ()
	Extract custom captions from search-interwiki-custom message. More...

	getDidYouMeanHtml (SearchResultSet $textMatches)
	Generates HTML shown to the user when we have a suggestion about a query that might give more results than their current query. More...

	getDidYouMeanRewrittenHtml ($term, SearchResultSet $textMatches)
	Generates HTML shown to user when their query has been internally rewritten, and the results of the rewritten query are being returned. More...

	getGroupName ()

	getSearchProfiles ()

	interwikiHeader ($interwiki, $interwikiResult)
	Produce wiki header for interwiki results. More...

	isPowerSearch ()
	Return true if current search is a power (advanced) search. More...

	makeSearchLink ($term, $namespaces, $label, $tooltip, $params=[])
	Make a search link with some target namespaces. More...

	powerSearch (&$request)
	Extract "power search" namespace settings from the request object, returning a list of index numbers to search. More...

	powerSearchBox ($term, $opts)
	Generates the power search box at [[Special:Search]]. More...

	powerSearchOptions ()
	Reconstruct the 'power search' options for links. More...

	saveNamespaces ()
	Save namespace preferences when we're supposed to. More...

	searchOptions ($term)

	searchProfileTabs ($term)

	setupPage ($term)

	shortDialog ($term, $resultsShown, $totalNum)

	shouldRunSuggestedQuery (SearchResultSet $textMatches)
	Decide if the suggested query should be run, and it's results returned instead of the provided $textMatches. More...

	showCreateLink ($title, $num, $titleMatches, $textMatches)

	showHit (SearchResult $result, $terms, $position)
	Format a single hit result. More...

	showInterwiki ($matches, $query)
	Show results from other wikis. More...

	showInterwikiHit ($result, $lastInterwiki, $query)
	Show single interwiki link. More...

	showMatches ($matches, $interwiki=null)
	Show whole set of results. More...

	startsWithAll ($term)
	Check if query starts with all: prefix. More...

	startsWithImage ($term)
	Check if query starts with image: prefix. More...

Protected Member Functions inherited from SpecialPage
	addFeedLinks ($params)
	Adds RSS/atom links. More...

	afterExecute ($subPage)
	Gets called after. More...

	beforeExecute ($subPage)
	Gets called before. More...

	checkLoginSecurityLevel ($level=null)
	Verifies that the user meets the security level, possibly reauthenticating them in the process. More...

	getCacheTTL ()

	getGroupName ()
	Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'. More...

	getLinkRenderer ()

	getLoginSecurityLevel ()
	Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g. More...

	getRobotPolicy ()
	Return the robot policy. More...

	getSubpagesForPrefixSearch ()
	Return an array of subpages that this special page will accept for prefix searches. More...

	prefixSearchString ($search, $limit, $offset)
	Perform a regular substring search for prefixSearchSubpages. More...

	useTransactionalTimeLimit ()
	Call wfTransactionalTimeLimit() if this request was POSTed. More...

Protected Attributes
array	$customCaptions
	Names of the wikis, in format: Interwiki prefix -> caption. More...

array	$extraParams = []
	For links. More...

string	$fulltext

int	$limit

string	$mPrefix
	The prefix url parameter. More...

array	$namespaces

null string	$profile
	Current search profile. More...

bool	$runSuggestion = true

SearchEngineConfig	$searchConfig
	Search engine configurations. More...

SearchEngine	$searchEngine
	Search engine. More...

string	$searchEngineType
	Search engine type, if not default. More...

Protected Attributes inherited from SpecialPage
IContextSource	$mContext
	Current request context. More...

	$mIncludable

	$mIncluding

	$mName

	$mRestriction

Additional Inherited Members
Static Public Member Functions inherited from SpecialPage
static	getSafeTitleFor ($name, $subpage=false)
	Get a localised Title object for a page name with a possibly unvalidated subpage. More...

static	getTitleFor ($name, $subpage=false, $fragment= '')
	Get a localised Title object for a specified special page name If you don't need a full Title object, consider using TitleValue through getTitleValueFor() below. More...

static	getTitleValueFor ($name, $subpage=false, $fragment= '')
	Get a localised TitleValue object for a specified special page name. More...

Static Protected Member Functions inherited from SpecialPage
static	prefixSearchArray ($search, $limit, array $subpages, $offset)
	Helper function for implementations of prefixSearchSubpages() that filter the values in memory (as opposed to making a query). More...

Detailed Description

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

Definition at line 32 of file SpecialSearch.php.

Constructor & Destructor Documentation

SpecialSearch::__construct ( )

Definition at line 92 of file SpecialSearch.php.

Member Function Documentation

SpecialSearch::execute ( $par )

Entry point.

Parameters

string $par

Definition at line 102 of file SpecialSearch.php.

References $out, $query, $request, SpecialPage\addHelpLink(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\getRequest(), goResult(), load(), SpecialPage\outputHeader(), saveNamespaces(), SpecialPage\setHeaders(), and showResults().

SpecialSearch::getCustomCaptions ( )

protected

Extract custom captions from search-interwiki-custom message.

Definition at line 910 of file SpecialSearch.php.

References $line, as, SpecialPage\msg(), and text.

Referenced by showInterwiki().

SpecialSearch::getDidYouMeanHtml ( SearchResultSet $textMatches )

protected

Generates HTML shown to the user when we have a suggestion about a query that might give more results than their current query.

Definition at line 496 of file SpecialSearch.php.

References $fulltext, $params, SpecialPage\getPageTitle(), SearchResultSet\getSuggestionQuery(), SearchResultSet\getSuggestionSnippet(), Linker\linkKnown(), SpecialPage\msg(), powerSearchOptions(), and Html\rawElement().

Referenced by showResults().

SpecialSearch::getDidYouMeanRewrittenHtml	(		$term,
		SearchResultSet	$textMatches
	)

protected

Generates HTML shown to user when their query has been internally rewritten, and the results of the rewritten query are being returned.

Parameters

string	$term	The users search input
SearchResultSet	$textMatches	The response to the users initial search request

Returns: string HTML linking the user to their original $term query, and the one suggested by $textMatches.

Definition at line 530 of file SpecialSearch.php.

References $fulltext, $params, $term, SpecialPage\getPageTitle(), SearchResultSet\getQueryAfterRewrite(), SearchResultSet\getQueryAfterRewriteSnippet(), Linker\linkKnown(), SpecialPage\msg(), powerSearchOptions(), and Html\rawElement().

Referenced by showResults().

SpecialSearch::getGroupName ( )

protected

Definition at line 1400 of file SpecialSearch.php.

SpecialSearch::getNamespaces ( )

Current namespaces.

Returns: array

Definition at line 1383 of file SpecialSearch.php.

References $namespaces.

SpecialSearch::getProfile ( )

Current search profile.

Returns: null|string

Definition at line 1375 of file SpecialSearch.php.

References $profile.

SpecialSearch::getSearchEngine ( )

Since: 1.18

Returns: SearchEngine

Definition at line 1361 of file SpecialSearch.php.

References $searchEngine.

Referenced by goResult(), and showResults().

SpecialSearch::getSearchProfiles ( )

protected

Returns: array

Definition at line 1133 of file SpecialSearch.php.

References as, NS_FILE, and Hooks\run().

Referenced by load(), and searchProfileTabs().

SpecialSearch::goResult ( $term )

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

Parameters

string $term

Definition at line 213 of file SpecialSearch.php.

References $term, $title, SpecialPage\getConfig(), SpecialPage\getOutput(), getSearchEngine(), Title\newFromText(), Hooks\run(), setupPage(), and showResults().

Referenced by execute().

SpecialSearch::interwikiHeader	(	$interwiki,
		$interwikiResult
	)

protected

Produce wiki header for interwiki results.

Parameters

string	$interwiki	Interwiki name
SearchResultSet	$interwikiResult	The result set

Returns: string

Definition at line 467 of file SpecialSearch.php.

References SpecialPage\msg().

Referenced by showMatches().

SpecialSearch::isPowerSearch ( )

protected

Return true if current search is a power (advanced) search.

Returns: bool

Definition at line 635 of file SpecialSearch.php.

Referenced by powerSearchOptions(), searchOptions(), and showResults().

SpecialSearch::load ( )

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

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

Definition at line 161 of file SpecialSearch.php.

References $profile, $request, $user, as, SpecialPage\getRequest(), getSearchProfiles(), SpecialPage\getUser(), list, namespaces, and powerSearch().

Referenced by execute().

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

protected

Make a search link with some target namespaces.

Parameters

string	$term
array	$namespaces	Ignored
string	$label	Link's text
string	$tooltip	Link's tooltip
array	$params	Query string parameters

Returns: string HTML fragment

Definition at line 1297 of file SpecialSearch.php.

References $params, $term, as, Xml\element(), SpecialPage\getPageTitle(), SpecialPage\msg(), and text.

Referenced by searchProfileTabs().

SpecialSearch::powerSearch ( & $request )

protected

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

Parameters

WebRequest $request

Returns: array

Definition at line 646 of file SpecialSearch.php.

References $name, $request, and as.

Referenced by load().

SpecialSearch::powerSearchBox	(	$term,
		$opts
	)

protected

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

Parameters

string	$term	Search term
array	$opts

Returns: string HTML form

Definition at line 1047 of file SpecialSearch.php.

References $name, $term, $user, $value, $wgContLang, as, Xml\checkLabel(), Xml\closeElement(), Xml\element(), MWNamespace\getSubject(), SpecialPage\getUser(), global, Html\hidden(), SpecialPage\msg(), namespaces, Xml\openElement(), Hooks\run(), Xml\tags(), and text.

Referenced by searchOptions().

SpecialSearch::powerSearchOptions ( )

protected

Reconstruct the 'power search' options for links.

Returns: array

Definition at line 662 of file SpecialSearch.php.

References $extraParams, $profile, as, isPowerSearch(), and namespaces.

Referenced by getDidYouMeanHtml(), getDidYouMeanRewrittenHtml(), and showResults().

SpecialSearch::saveNamespaces ( )

protected

Save namespace preferences when we're supposed to.

Returns: bool Whether we wrote something

Definition at line 680 of file SpecialSearch.php.

References $request, $user, DeferredUpdates\addCallableUpdate(), as, SpecialPage\getRequest(), SpecialPage\getUser(), MWNamespace\getValidNamespaces(), namespaces, use, and wfReadOnly().

Referenced by execute().

SpecialSearch::searchOptions ( $term )

protected

Parameters

string $term Search term

Returns: string

Definition at line 1229 of file SpecialSearch.php.

References $out, $profile, $term, isPowerSearch(), powerSearchBox(), and Hooks\run().

Referenced by showResults().

SpecialSearch::searchProfileTabs ( $term )

protected

Parameters

string $term

Returns: string

Definition at line 1179 of file SpecialSearch.php.

References $lang, $out, $term, as, Xml\closeElement(), Xml\element(), Html\element(), SpecialPage\getLanguage(), getSearchProfiles(), makeSearchLink(), SpecialPage\msg(), Xml\openElement(), startsWithImage(), Xml\tags(), and text.

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

string	$key
mixed	$value

Definition at line 1396 of file SpecialSearch.php.

References $value.

Referenced by showResults().

SpecialSearch::setupPage ( $term )

protected

Parameters

string $term

Definition at line 617 of file SpecialSearch.php.

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

Referenced by goResult(), and showResults().

SpecialSearch::shortDialog	(	$term,
		$resultsShown,
		$totalNum
	)

protected

Parameters

string	$term
int	$resultsShown
int	$totalNum

Returns: string

Definition at line 1251 of file SpecialSearch.php.

References $out, $term, SpecialPage\getPageTitle(), Html\hidden(), SpecialPage\msg(), Xml\tags(), and text.

SpecialSearch::shouldRunSuggestedQuery ( SearchResultSet $textMatches )

protected

Decide if the suggested query should be run, and it's results returned instead of the provided $textMatches.

Parameters

SearchResultSet $textMatches The results of a users query

Returns: bool

Definition at line 480 of file SpecialSearch.php.

References SpecialPage\getConfig(), SearchResultSet\hasSuggestion(), SearchResultSet\numRows(), and SearchResultSet\searchContainedSyntax().

SpecialSearch::showCreateLink	(	$title,
		$num,
		$titleMatches,
		$textMatches
	)

protected

Parameters

Title	$title
int	$num	The number of search results found
null \| SearchResultSet	$titleMatches	Results from title search
null \| SearchResultSet	$textMatches	Results from text search

Definition at line 571 of file SpecialSearch.php.

References $params, $title, SpecialPage\getOutput(), Message\numParam(), Hooks\run(), and wfEscapeWikiText().

Referenced by showResults().

SpecialSearch::showHit	(	SearchResult	$result,
			$terms,
			$position
	)

protected

Format a single hit result.

Parameters

SearchResult	$result
array	$terms	Terms to highlight
int	$position	Position within the search results, including offset.

Returns: string

Definition at line 754 of file SpecialSearch.php.

Referenced by showMatches().

SpecialSearch::showInterwiki	(	$matches,
		$query
	)

protected

Show results from other wikis.

Parameters

SearchResultSet \| array	$matches
string	$query

Returns: string

Definition at line 932 of file SpecialSearch.php.

References $matches, $out, $query, $wgContLang, as, getCustomCaptions(), global, SpecialPage\msg(), and showInterwikiHit().

Referenced by showResults().

SpecialSearch::showInterwikiHit	(	$result,
		$lastInterwiki,
		$query
	)

protected

Show single interwiki link.

Parameters

SearchResult	$result
string	$lastInterwiki
string	$query

Returns: string

Definition at line 974 of file SpecialSearch.php.

References $customCaptions, $link, $out, $query, $title, Linker\linkKnown(), SpecialPage\msg(), Title\newFromText(), text, and wfParseUrl().

Referenced by showInterwiki().

SpecialSearch::showMatches	(	$matches,
		$interwiki = `null`
	)

protected

Show whole set of results.

Parameters

SearchResultSet	$matches
string	$interwiki	Interwiki name

Returns: string

Definition at line 720 of file SpecialSearch.php.

References $matches, $offset, $out, $wgContLang, global, interwikiHeader(), and showHit().

Referenced by showResults().

SpecialSearch::showResults ( $term )

Parameters

string $term

Definition at line 248 of file SpecialSearch.php.

References $mPrefix, $out, $term, $title, $wgContLang, as, Xml\closeElement(), Xml\element(), SpecialPage\getConfig(), getDidYouMeanHtml(), getDidYouMeanRewrittenHtml(), SpecialPage\getLanguage(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), getSearchEngine(), global, is(), isPowerSearch(), SpecialPage\msg(), name, namespaces, Title\newFromText(), NS_FILE, Xml\openElement(), powerSearchOptions(), Hooks\run(), searchOptions(), searchProfileTabs(), setExtraParam(), setupPage(), showCreateLink(), showInterwiki(), showMatches(), text, wfEscapeWikiText(), and wfScript().

Referenced by execute(), and goResult().

SpecialSearch::startsWithAll ( $term )

protected

Check if query starts with all: prefix.

Parameters

string $term The string to check

Returns: bool

Definition at line 1344 of file SpecialSearch.php.

References $term, and SpecialPage\msg().

SpecialSearch::startsWithImage ( $term )

protected

Check if query starts with image: prefix.

Parameters

string $term The string to check

Returns: bool

Definition at line 1327 of file SpecialSearch.php.

References $term, $wgContLang, global, and NS_FILE.

Referenced by searchProfileTabs().

Member Data Documentation

array SpecialSearch::$customCaptions

protected

Names of the wikis, in format: Interwiki prefix -> caption.

Definition at line 82 of file SpecialSearch.php.

Referenced by showInterwikiHit().

array SpecialSearch::$extraParams = []

protected

For links.

Definition at line 50 of file SpecialSearch.php.

Referenced by powerSearchOptions().

string SpecialSearch::$fulltext

protected

Definition at line 71 of file SpecialSearch.php.

Referenced by getDidYouMeanHtml(), and getDidYouMeanRewrittenHtml().

int SpecialSearch::$limit

protected

Definition at line 61 of file SpecialSearch.php.

string SpecialSearch::$mPrefix

protected

The prefix url parameter.

Set on the searcher and the is expected to treat it as prefix filter on titles.

Definition at line 56 of file SpecialSearch.php.

Referenced by showResults().

array SpecialSearch::$namespaces

protected

Definition at line 66 of file SpecialSearch.php.

Referenced by getNamespaces().

int SpecialSearch::$offset

Definition at line 61 of file SpecialSearch.php.

Referenced by showMatches().

null string SpecialSearch::$profile

protected

Current search profile.

Search profile is just a name that identifies the active search tab on the search page (content, 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.

Definition at line 41 of file SpecialSearch.php.

Referenced by getProfile(), load(), powerSearchOptions(), and searchOptions().

bool SpecialSearch::$runSuggestion = true

protected

Definition at line 76 of file SpecialSearch.php.

SearchEngineConfig SpecialSearch::$searchConfig

protected

Search engine configurations.

Definition at line 88 of file SpecialSearch.php.

SearchEngine SpecialSearch::$searchEngine

protected

Search engine.

Definition at line 44 of file SpecialSearch.php.

Referenced by getSearchEngine().

string SpecialSearch::$searchEngineType

protected

Search engine type, if not default.

Definition at line 47 of file SpecialSearch.php.

const SpecialSearch::NAMESPACES_CURRENT = 'sense'

Definition at line 90 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

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation