MediaWiki  master
MediaWiki\Widget\SearchInputWidget Class Reference

Search input widget. More...

Inheritance diagram for MediaWiki\Widget\SearchInputWidget:
Collaboration diagram for MediaWiki\Widget\SearchInputWidget:

Public Member Functions

 __construct (array $config=[])
 
 getConfig (&$config)
 
- Public Member Functions inherited from MediaWiki\Widget\TitleInputWidget
 __construct (array $config=[])
 
 getConfig (&$config)
 

Protected Member Functions

 getInputElement ( $config)
 
 getJavaScriptClassName ()
 
- Protected Member Functions inherited from MediaWiki\Widget\TitleInputWidget
 getJavaScriptClassName ()
 

Protected Attributes

 $dataLocation = 'header'
 
 $highlightFirst = false
 
 $performSearchOnClick = true
 
 $showDescriptions = false
 
 $validateTitle = false
 
- Protected Attributes inherited from MediaWiki\Widget\TitleInputWidget
 $highlightFirst = null
 
 $namespace = null
 
 $relative = null
 
 $suggestions = null
 
 $validateTitle = null
 

Detailed Description

Search input widget.

Note
2011-2015 MediaWiki Widgets Team and others; see AUTHORS.txt
MIT

Definition at line 11 of file SearchInputWidget.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Widget\SearchInputWidget::__construct ( array  $config = [])
Parameters
array$configConfiguration options
  • bool|null $config['performSearchOnClick'] If true, the script will start a search whenever a user hits a suggestion. If false, the text of the suggestion is inserted into the text field only (default: true)
  • string $config['dataLocation'] Where the search input field will be used (header or content, default: header)

Definition at line 27 of file SearchInputWidget.php.

References MediaWiki\$config.

Member Function Documentation

◆ getConfig()

MediaWiki\Widget\SearchInputWidget::getConfig ( $config)

◆ getInputElement()

MediaWiki\Widget\SearchInputWidget::getInputElement (   $config)
protected

Definition at line 53 of file SearchInputWidget.php.

◆ getJavaScriptClassName()

MediaWiki\Widget\SearchInputWidget::getJavaScriptClassName ( )
protected

Definition at line 57 of file SearchInputWidget.php.

Member Data Documentation

◆ $dataLocation

MediaWiki\Widget\SearchInputWidget::$dataLocation = 'header'
protected

Definition at line 16 of file SearchInputWidget.php.

Referenced by MediaWiki\Widget\SearchInputWidget\getConfig().

◆ $highlightFirst

MediaWiki\Widget\SearchInputWidget::$highlightFirst = false
protected

Definition at line 15 of file SearchInputWidget.php.

◆ $performSearchOnClick

MediaWiki\Widget\SearchInputWidget::$performSearchOnClick = true
protected

Definition at line 13 of file SearchInputWidget.php.

Referenced by MediaWiki\Widget\SearchInputWidget\getConfig().

◆ $showDescriptions

MediaWiki\Widget\SearchInputWidget::$showDescriptions = false
protected

Definition at line 17 of file SearchInputWidget.php.

◆ $validateTitle

MediaWiki\Widget\SearchInputWidget::$validateTitle = false
protected

Definition at line 14 of file SearchInputWidget.php.


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