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

Collaboration diagram for SpecialSearch:

[legend]

Public Member Functions
	__construct (SearchEngineConfig $searchConfig, SearchEngineFactory $searchEngineFactory, NamespaceInfo $nsInfo, IContentHandlerFactory $contentHandlerFactory, InterwikiLookup $interwikiLookup, ReadOnlyMode $readOnlyMode, UserOptionsManager $userOptionsManager, LanguageConverterFactory $languageConverterFactory, RepoGroup $repoGroup, SearchResultThumbnailProvider $thumbnailProvider, TitleMatcher $titleMatcher)

	execute ( $par)
	Entry point.

	getNamespaces ()
	Current namespaces.

	getPrefix ()
	The prefix value send to Special:Search using the 'prefix' URI param It means that the user is willing to search for pages whose titles start with this prefix value.

	getProfile ()
	Current search profile.

	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.

	powerSearchOptions ()
	Reconstruct the 'power search' options for links TODO: Instead of exposing this publicly, could we instead expose a function for creating search links?

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

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

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

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

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

	getAssociatedNavigationLinks ()
	Return an array of strings representing page titles that are discoverable to end users via UI.

	getAuthority ()
	Shortcut to get the Authority executing this instance.

	getConfig ()
	Shortcut to get main config object.

	getContentLanguage ()
	Shortcut to get content language.

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

	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.

	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.

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

	getLanguage ()
	Shortcut to get user's language.

	getLinkRenderer ()

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

	getName ()
	Get the name of this Special Page.

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

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

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

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

	getShortDescription (string $path='')
	Similar to getDescription but takes into account sub pages and designed for display in tabs.

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

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

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

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

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

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

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

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

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

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

	msg ( $key,... $params)
	Wrapper around wfMessage that sets the current context.

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

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

	requireNamedUser ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
	If the user is not logged in or is a temporary user, throws UserNotLoggedIn.

	run ( $subPage)
	Entry point.

	setContentLanguage (Language $contentLanguage)
	Set content language.

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

	setHookContainer (HookContainer $hookContainer)

	setLinkRenderer (LinkRenderer $linkRenderer)

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

	setSpecialPageFactory (SpecialPageFactory $specialPageFactory)

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

Protected Member Functions
	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'.

	getSearchProfiles ()

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

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

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

	setupPage ( $term)
	Sets up everything for the HTML output page including styles, javascript, page title, etc.

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

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

	afterExecute ( $subPage)
	Gets called after.

	beforeExecute ( $subPage)
	Gets called before.

	buildPrevNextNavigation ( $offset, $limit, array $query=[], $atend=false, $subpage=false)
	Generate (prev x\| next x) (20\|50\|100...) type links for paging.

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

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

	getAuthManager ()

	getCacheTTL ()

	getHookContainer ()

	getHookRunner ()

	getLanguageConverter ()
	Shortcut to get language's converter.

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

	getRobotPolicy ()
	Return the robot policy.

	getSpecialPageFactory ()

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

	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.

	prefixSearchString ( $search, $limit, $offset, SearchEngineFactory $searchEngineFactory=null)
	Perform a regular substring search for prefixSearchSubpages.

	setAuthManager (AuthManager $authManager)
	Set the injected AuthManager from the special page constructor.

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

	setReauthPostData (array $data)
	Record preserved POST data after a reauthentication.

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

Protected Attributes
array	$extraParams = []
	For links.

string	$fulltext

int	$limit

string	$mPrefix
	The prefix url parameter.

array	$namespaces

int	$offset

null string	$profile
	Current search profile.

bool	$runSuggestion = true

SearchEngineConfig	$searchConfig
	Search engine configurations.

SearchEngine	$searchEngine
	Search engine.

string null	$searchEngineType = null
	Search engine type, if not default.

string	$sort = SearchEngine::DEFAULT_SORT

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

bool	$mIncludable
	Whether the special page can be included in an article.

bool	$mIncluding
	Whether or not this special page is being included from an article.

string	$mName
	The canonical name of this special page Also used for the default.

string	$mRestriction
	Minimum user level required to access this page, or "" for anyone.

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.

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.

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

static	newSearchPage (User $user)
	Get the users preferred search page.

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

Detailed Description

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

Definition at line 46 of file SpecialSearch.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialSearch::__construct	(	SearchEngineConfig	$searchConfig,
		SearchEngineFactory	$searchEngineFactory,
		NamespaceInfo	$nsInfo,
		IContentHandlerFactory	$contentHandlerFactory,
		InterwikiLookup	$interwikiLookup,
		ReadOnlyMode	$readOnlyMode,
		UserOptionsManager	$userOptionsManager,
		LanguageConverterFactory	$languageConverterFactory,
		RepoGroup	$repoGroup,
		SearchResultThumbnailProvider	$thumbnailProvider,
		TitleMatcher	$titleMatcher )

Parameters

SearchEngineConfig	$searchConfig
SearchEngineFactory	$searchEngineFactory
NamespaceInfo	$nsInfo
IContentHandlerFactory	$contentHandlerFactory
InterwikiLookup	$interwikiLookup
ReadOnlyMode	$readOnlyMode
UserOptionsManager	$userOptionsManager
LanguageConverterFactory	$languageConverterFactory
RepoGroup	$repoGroup
SearchResultThumbnailProvider	$thumbnailProvider
TitleMatcher	$titleMatcher

Definition at line 153 of file SpecialSearch.php.

Member Function Documentation

◆ execute()

SpecialSearch::execute ( $par )

Entry point.

Parameters

string | null $par

Reimplemented from SpecialPage.

Definition at line 185 of file SpecialSearch.php.

References $title, SpecialPage\getConfig(), SpecialPage\getHookRunner(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\getRequest(), goResult(), load(), saveNamespaces(), setupPage(), and showResults().

◆ getGroupName()

SpecialSearch::getGroupName ( )

protected

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

Stability: stable: to override

Returns: string

Since: 1.21

Reimplemented from SpecialPage.

Definition at line 927 of file SpecialSearch.php.

◆ getNamespaces()

SpecialSearch::getNamespaces ( )

Current namespaces.

Returns: array

Definition at line 867 of file SpecialSearch.php.

◆ getPrefix()

SpecialSearch::getPrefix ( )

The prefix value send to Special:Search using the 'prefix' URI param It means that the user is willing to search for pages whose titles start with this prefix value.

(Used by the InputBox extension)

Returns: string

Definition at line 892 of file SpecialSearch.php.

◆ getProfile()

SpecialSearch::getProfile ( )

Current search profile.

Returns: null|string

Definition at line 859 of file SpecialSearch.php.

◆ getSearchEngine()

SpecialSearch::getSearchEngine ( )

Since: 1.18

Returns: SearchEngine

Definition at line 847 of file SpecialSearch.php.

Referenced by load(), and showResults().

◆ getSearchProfiles()

SpecialSearch::getSearchProfiles ( )

protected

Returns: array[]

Definition at line 800 of file SpecialSearch.php.

References SpecialPage\getHookRunner(), and NS_FILE.

Referenced by load().

◆ goResult()

SpecialSearch::goResult ( $term )

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

Parameters

string $term

Returns: string|null The url to redirect to, or null if no redirect.

Definition at line 356 of file SpecialSearch.php.

References $title, SpecialPage\getHookRunner(), and NS_MAIN.

Referenced by execute().

◆ isPowerSearch()

SpecialSearch::isPowerSearch ( )

protected

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

Returns: bool

Definition at line 717 of file SpecialSearch.php.

Referenced by powerSearchOptions().

◆ load()

SpecialSearch::load ( )

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

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

Definition at line 283 of file SpecialSearch.php.

References SpecialPage\getRequest(), getSearchEngine(), getSearchProfiles(), getUser(), powerSearch(), and setExtraParam().

Referenced by execute().

◆ powerSearch()

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 728 of file SpecialSearch.php.

Referenced by load().

◆ powerSearchOptions()

SpecialSearch::powerSearchOptions ( )

Reconstruct the 'power search' options for links TODO: Instead of exposing this publicly, could we instead expose a function for creating search links?

Returns: array

Definition at line 746 of file SpecialSearch.php.

References isPowerSearch().

Referenced by setupPage().

◆ saveNamespaces()

SpecialSearch::saveNamespaces ( )

protected

Save namespace preferences when we're supposed to.

Returns: bool Whether we wrote something

Definition at line 764 of file SpecialSearch.php.

References SpecialPage\getRequest(), and getUser().

Referenced by execute().

◆ setExtraParam()

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 880 of file SpecialSearch.php.

Referenced by load(), and showResults().

◆ setupPage()

SpecialSearch::setupPage ( $term )

protected

Sets up everything for the HTML output page including styles, javascript, page title, etc.

Parameters

string $term

Definition at line 664 of file SpecialSearch.php.

References SpecialPage\addHelpLink(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\msg(), SpecialPage\outputHeader(), powerSearchOptions(), and SpecialPage\setHeaders().

Referenced by execute().

◆ showCreateLink()

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

protected

Parameters

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

Definition at line 610 of file SpecialSearch.php.

References $title, SpecialPage\getHookRunner(), SpecialPage\getOutput(), Message\numParam(), and wfEscapeWikiText().

Referenced by showResults().

◆ showResults()

SpecialSearch::showResults ( $term )

Parameters

string $term

Definition at line 402 of file SpecialSearch.php.

References $title, SpecialPage\getConfig(), SpecialPage\getContentLanguage(), SpecialPage\getHookContainer(), SpecialPage\getHookRunner(), SpecialPage\getLinkRenderer(), SpecialPage\getOutput(), getSearchEngine(), NS_FILE, setExtraParam(), showCreateLink(), wfDeprecatedMsg(), and wfEscapeWikiText().

Referenced by execute().

Member Data Documentation

◆ $extraParams

array SpecialSearch::$extraParams = []

protected

For links.

Definition at line 64 of file SpecialSearch.php.

◆ $fulltext

string SpecialSearch::$fulltext

protected

Definition at line 85 of file SpecialSearch.php.

◆ $limit

int SpecialSearch::$limit

protected

Definition at line 75 of file SpecialSearch.php.

◆ $mPrefix

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 70 of file SpecialSearch.php.

◆ $namespaces

array SpecialSearch::$namespaces

protected

Definition at line 80 of file SpecialSearch.php.

◆ $offset

int SpecialSearch::$offset

protected

Definition at line 75 of file SpecialSearch.php.

◆ $profile

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 55 of file SpecialSearch.php.

◆ $runSuggestion

bool SpecialSearch::$runSuggestion = true

protected

Definition at line 95 of file SpecialSearch.php.

◆ $searchConfig

SearchEngineConfig SpecialSearch::$searchConfig

protected

Search engine configurations.

Definition at line 101 of file SpecialSearch.php.

◆ $searchEngine

SearchEngine SpecialSearch::$searchEngine

protected

Search engine.

Definition at line 58 of file SpecialSearch.php.

◆ $searchEngineType

string null SpecialSearch::$searchEngineType = null

protected

Search engine type, if not default.

Definition at line 61 of file SpecialSearch.php.

◆ $sort

string SpecialSearch::$sort = SearchEngine::DEFAULT_SORT

protected

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

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ execute()

◆ getGroupName()

◆ getNamespaces()

◆ getPrefix()

◆ getProfile()

◆ getSearchEngine()

◆ getSearchProfiles()

◆ goResult()

◆ isPowerSearch()

◆ load()

◆ powerSearch()

◆ powerSearchOptions()

◆ saveNamespaces()

◆ setExtraParam()

◆ setupPage()

◆ showCreateLink()

◆ showResults()

Member Data Documentation

◆ $extraParams

◆ $fulltext

◆ $limit

◆ $mPrefix

◆ $namespaces

◆ $offset

◆ $profile

◆ $runSuggestion

◆ $searchConfig

◆ $searchEngine

◆ $searchEngineType

◆ $sort