BlueSpice MediaWiki master
 All Classes Namespaces Files Functions Variables Groups Pages
SpecialSearch Class Reference
Inheritance diagram for SpecialSearch:
Collaboration diagram for SpecialSearch:

Public Member Functions

 execute ($par)
 
 load ()
 
 goResult ($term)
 
 showResults ($term)
 
 powerSearchOptions ()
 
 getSearchEngine ()
 
 getProfile ()
 
 getNamespaces ()
 
 setExtraParam ($key, $value)
 
- Public Member Functions inherited from SpecialPage
 __construct ($name= '', $restriction= '', $listed=true, $function=false, $file= '', $includable=false)
 
 getName ()
 
 getRestriction ()
 
 isListed ()
 
 setListed ($listed)
 
 listed ($x=null)
 
 isIncludable ()
 
 maxIncludeCacheTime ()
 
 including ($x=null)
 
 getLocalName ()
 
 isExpensive ()
 
 isCached ()
 
 isRestricted ()
 
 userCanExecute (User $user)
 
 displayRestrictionError ()
 
 checkPermissions ()
 
 checkReadOnly ()
 
 requireLogin ($reasonMsg= 'exception-nologin-text', $titleMsg= 'exception-nologin')
 
 prefixSearchSubpages ($search, $limit, $offset)
 
 setHeaders ()
 
 run ($subPage)
 
 execute ($subPage)
 
 outputHeader ($summaryMessageKey= '')
 
 getDescription ()
 
 getTitle ($subpage=false)
 
 getPageTitle ($subpage=false)
 
 setContext ($context)
 
 getContext ()
 
 getRequest ()
 
 getOutput ()
 
 getUser ()
 
 getSkin ()
 
 getLanguage ()
 
 getConfig ()
 
 getFullTitle ()
 
 msg ($key)
 
 addHelpLink ($to, $overrideBaseUrl=false)
 
 getFinalGroupName ()
 
 doesWrites ()
 
 getLinkRenderer ()
 
 setLinkRenderer (LinkRenderer $linkRenderer)
 

Public Attributes

 $offset
 
const NAMESPACES_CURRENT = 'sense'
 

Protected Member Functions

 showCreateLink ($title, $num, $titleMatches, $textMatches)
 
 setupPage ($term)
 
 isPowerSearch ()
 
 powerSearch (&$request)
 
 saveNamespaces ()
 
 getSearchProfiles ()
 
 getGroupName ()
 
- Protected Member Functions inherited from SpecialPage
 getCacheTTL ()
 
 getLoginSecurityLevel ()
 
 checkLoginSecurityLevel ($level=null)
 
 getSubpagesForPrefixSearch ()
 
 prefixSearchString ($search, $limit, $offset)
 
 beforeExecute ($subPage)
 
 afterExecute ($subPage)
 
 getRobotPolicy ()
 
 addFeedLinks ($params)
 
 getGroupName ()
 
 useTransactionalTimeLimit ()
 

Protected Attributes

 $profile
 
 $searchEngine
 
 $searchEngineType
 
 $extraParams = []
 
 $mPrefix
 
 $limit
 
 $namespaces
 
 $fulltext
 
 $runSuggestion = true
 
 $searchConfig
 
- Protected Attributes inherited from SpecialPage
 $mName
 
 $mRestriction
 
 $mIncluding
 
 $mIncludable
 
 $mContext
 

Additional Inherited Members

- Static Public Member Functions inherited from SpecialPage
static getTitleFor ($name, $subpage=false, $fragment= '')
 
static getTitleValueFor ($name, $subpage=false, $fragment= '')
 
static getSafeTitleFor ($name, $subpage=false)
 
- Static Protected Member Functions inherited from SpecialPage
static prefixSearchArray ($search, $limit, array $subpages, $offset)
 

Detailed Description

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

Member Function Documentation

SpecialSearch::execute (   $par)

Entry point

Parameters
string$par
SpecialSearch::getNamespaces ( )

Current namespaces.

Returns
array
SpecialSearch::getProfile ( )

Current search profile.

Returns
null|string
SpecialSearch::getSearchEngine ( )
Since
1.18
Returns
SearchEngine
SpecialSearch::getSearchProfiles ( )
protected
Returns
array
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.
SpecialSearch::isPowerSearch ( )
protected

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

Returns
bool
SpecialSearch::load ( )

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

See Also
tests/phpunit/includes/specials/SpecialSearchTest.php
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
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
SpecialSearch::saveNamespaces ( )
protected

Save namespace preferences when we're supposed to

Returns
bool Whether we wrote something
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
SpecialSearch::setupPage (   $term)
protected

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

Parameters
string$term
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
SpecialSearch::showResults (   $term)
Parameters
string$term

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