MediaWiki  master
SpecialSearch Class Reference

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...
 
 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. 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...
 
 powerSearchOptions ()
 Reconstruct the 'power search' options for links TODO: Instead of exposing this publicly, could we instead expose a function for creating search links? 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...
 
 getLinkRenderer ()
 
 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 ( $key)
 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

 getGroupName ()
 
 getSearchProfiles ()
 
 isPowerSearch ()
 Return true if current search is a power (advanced) search. More...
 
 powerSearch (&$request)
 Extract "power search" namespace settings from the request object, returning a list of index numbers to search. More...
 
 saveNamespaces ()
 Save namespace preferences when we're supposed to. More...
 
 setupPage ( $term)
 Sets up everything for the HTML output page including styles, javascript, page title, etc. More...
 
 showCreateLink ( $title, $num, $titleMatches, $textMatches)
 
- 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...
 
 buildPrevNextNavigation ( $offset, $limit, array $query=[], $atend=false, $subpage=false)
 Generate (prev x| next x) (20|50|100...) type links for paging. 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...
 
 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...
 
 setReauthPostData (array $data)
 Record preserved POST data after a reauthentication. More...
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed. More...
 

Protected Attributes

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...
 
string $sort
 
- Protected Attributes inherited from SpecialPage
IContextSource $mContext
 Current request context. More...
 
 $mIncludable
 
 $mIncluding
 
 $mName
 
 $mRestriction
 

Private Member Functions

 showGoogleSearch ( $term)
 Output a google search form if search is disabled. More...
 

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

Constructor & Destructor Documentation

◆ __construct()

SpecialSearch::__construct ( )

Definition at line 97 of file SpecialSearch.php.

Member Function Documentation

◆ execute()

◆ getGroupName()

SpecialSearch::getGroupName ( )
protected

Definition at line 774 of file SpecialSearch.php.

◆ getNamespaces()

SpecialSearch::getNamespaces ( )

Current namespaces.

Returns
array

Definition at line 745 of file SpecialSearch.php.

References $namespaces.

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

References $mPrefix.

◆ getProfile()

SpecialSearch::getProfile ( )

Current search profile.

Returns
null|string

Definition at line 737 of file SpecialSearch.php.

References $profile.

◆ getSearchEngine()

SpecialSearch::getSearchEngine ( )
Since
1.18
Returns
SearchEngine

Definition at line 722 of file SpecialSearch.php.

References $searchEngine, $services, and null.

Referenced by goResult(), and showResults().

◆ getSearchProfiles()

SpecialSearch::getSearchProfiles ( )
protected
Returns
array

Definition at line 675 of file SpecialSearch.php.

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

Referenced by load(), and showResults().

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

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

Referenced by execute().

◆ isPowerSearch()

SpecialSearch::isPowerSearch ( )
protected

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

Returns
bool

Definition at line 591 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 206 of file SpecialSearch.php.

References $profile, $request, $user, as, SearchEngine\DEFAULT_SORT, SpecialPage\getRequest(), getSearchProfiles(), SpecialPage\getUser(), list, namespaces, null, 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 602 of file SpecialSearch.php.

References $name, $request, and as.

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

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

Referenced by setupPage(), and showResults().

◆ saveNamespaces()

SpecialSearch::saveNamespaces ( )
protected

Save namespace preferences when we're supposed to.

Returns
bool Whether we wrote something

Definition at line 638 of file SpecialSearch.php.

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

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

References $value.

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

References $out, $params, $term, SpecialPage\addHelpLink(), Xml\element(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\msg(), SpecialPage\outputHeader(), powerSearchOptions(), SpecialPage\setHeaders(), and text.

Referenced by execute().

◆ showCreateLink()

SpecialSearch::showCreateLink (   $title,
  $num,
  $titleMatches,
  $textMatches 
)
protected
Parameters
Title$title
int$numThe number of search results found
null | SearchResultSet$titleMatchesResults from title search
null | SearchResultSet$textMatchesResults from text search

Definition at line 487 of file SpecialSearch.php.

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

Referenced by showResults().

◆ showGoogleSearch()

SpecialSearch::showGoogleSearch (   $term)
private

Output a google search form if search is disabled.

Parameters
string$termSearch term
Todo:
FIXME Maybe we should get rid of this raw html message at some future time SecurityCheck-XSS

Definition at line 183 of file SpecialSearch.php.

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

Referenced by execute().

◆ showResults()

Member Data Documentation

◆ $extraParams

array SpecialSearch::$extraParams = []
protected

For links.

Definition at line 56 of file SpecialSearch.php.

Referenced by powerSearchOptions().

◆ $fulltext

string SpecialSearch::$fulltext
protected

Definition at line 77 of file SpecialSearch.php.

◆ $limit

int SpecialSearch::$limit
protected

Definition at line 67 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 62 of file SpecialSearch.php.

Referenced by getPrefix(), and showResults().

◆ $namespaces

array SpecialSearch::$namespaces
protected

Definition at line 72 of file SpecialSearch.php.

Referenced by getNamespaces().

◆ $offset

int SpecialSearch::$offset

Definition at line 67 of file SpecialSearch.php.

Referenced by showResults().

◆ $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 47 of file SpecialSearch.php.

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

◆ $runSuggestion

bool SpecialSearch::$runSuggestion = true
protected

Definition at line 87 of file SpecialSearch.php.

◆ $searchConfig

SearchEngineConfig SpecialSearch::$searchConfig
protected

Search engine configurations.

Definition at line 93 of file SpecialSearch.php.

◆ $searchEngine

SearchEngine SpecialSearch::$searchEngine
protected

Search engine.

Definition at line 50 of file SpecialSearch.php.

Referenced by getSearchEngine().

◆ $searchEngineType

string SpecialSearch::$searchEngineType
protected

Search engine type, if not default.

Definition at line 53 of file SpecialSearch.php.

◆ $sort

string SpecialSearch::$sort
protected

Definition at line 82 of file SpecialSearch.php.

◆ NAMESPACES_CURRENT

const SpecialSearch::NAMESPACES_CURRENT = 'sense'

Definition at line 95 of file SpecialSearch.php.


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