[ Index ]

PHP Cross Reference of MediaWiki-1.24.0

title

Body

[close]

/includes/specials/ -> SpecialSearch.php (summary)

Implements Special:Search Copyright © 2004 Brion Vibber <[email protected]>

File Size: 1196 lines (33 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

SpecialSearch:: (26 methods):
  __construct()
  execute()
  load()
  goResult()
  showResults()
  showCreateLink()
  setupPage()
  powerSearch()
  powerSearchOptions()
  saveNamespaces()
  showMatches()
  showHit()
  showInterwiki()
  showInterwikiHit()
  powerSearchBox()
  getSearchProfiles()
  formHeader()
  shortDialog()
  makeSearchLink()
  startsWithImage()
  startsWithAll()
  getSearchEngine()
  getProfile()
  getNamespaces()
  setExtraParam()
  getGroupName()


Class: SpecialSearch  - X-Ref

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

__construct()   X-Ref


execute( $par )   X-Ref
Entry point

param: string $par

load()   X-Ref
Set up basic search parameters from the request and user settings.


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

param: string $term

showResults( $term )   X-Ref

param: string $term

showCreateLink( $title, $num, $titleMatches, $textMatches )   X-Ref

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

setupPage( $term )   X-Ref

param: string $term

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

param: WebRequest $request
return: array

powerSearchOptions()   X-Ref
Reconstruct the 'power search' options for links

return: array

saveNamespaces()   X-Ref
Save namespace preferences when we're supposed to

return: bool Whether we wrote something

showMatches( &$matches )   X-Ref
Show whole set of results

param: SearchResultSet $matches
return: string

showHit( $result, $terms )   X-Ref
Format a single hit result

param: SearchResult $result
param: array $terms Terms to highlight
return: string

showInterwiki( $matches, $query )   X-Ref
Show results from other wikis

param: SearchResultSet|array $matches
param: string $query
return: string

showInterwikiHit( $result, $lastInterwiki, $query, $customCaptions )   X-Ref
Show single interwiki link

param: SearchResult $result
param: string $lastInterwiki
param: string $query
param: array $customCaptions Interwiki prefix -> caption
return: string

powerSearchBox( $term, $opts )   X-Ref
Generates the power search box at [[Special:Search]]

param: string $term Search term
param: array $opts
return: string HTML form

getSearchProfiles()   X-Ref

return: array

formHeader( $term )   X-Ref

param: string $term
return: string

shortDialog( $term, $resultsShown, $totalNum )   X-Ref

param: string $term
param: int $resultsShown
param: int $totalNum
return: string

makeSearchLink( $term, $namespaces, $label, $tooltip, $params = array()   X-Ref
Make a search link with some target namespaces

param: string $term
param: array $namespaces Ignored
param: string $label Link's text
param: string $tooltip Link's tooltip
param: array $params Query string parameters
return: string HTML fragment

startsWithImage( $term )   X-Ref
Check if query starts with image: prefix

param: string $term The string to check
return: bool

startsWithAll( $term )   X-Ref
Check if query starts with all: prefix

param: string $term The string to check
return: bool

getSearchEngine()   X-Ref

return: SearchEngine

getProfile()   X-Ref
Current search profile.

return: null|string

getNamespaces()   X-Ref
Current namespaces.

return: array

setExtraParam( $key, $value )   X-Ref
Users of hook SpecialSearchSetupEngine can use this to
add more params to links to not lose selection when
user navigates search results.

param: string $key
param: mixed $value

getGroupName()   X-Ref
No description



Generated: Fri Nov 28 14:03:12 2014 Cross-referenced by PHPXref 0.7.1