MediaWiki\Widget\TitleInputWidget Class Reference

Title input widget. More...

Inheritance diagram for MediaWiki\Widget\TitleInputWidget:

Collaboration diagram for MediaWiki\Widget\TitleInputWidget:

Public Member Functions
	__construct (array $config=[])
	getConfig (&$config)

Protected Member Functions
	getJavaScriptClassName ()

Protected Attributes
	$highlightFirst = null
	$namespace = null
	$relative = null
	$suggestions = null
	$validateTitle = null

Detailed Description

Title input widget.

Note

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

MIT

Definition at line 11 of file TitleInputWidget.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\Widget\TitleInputWidget::__construct

(

array

$config = []

)

Parameters

array

$config

Configuration options int|null $config['namespace'] Namespace to prepend to queries bool|null $config['relative'] If a namespace is set, return a title relative to it (default: true) bool|null $config['suggestions'] Display search suggestions (default: true) bool|null $config['highlightFirst'] Automatically highlight the first result (default: true) bool|null $config['validateTitle'] Whether the input must be a valid title (default: true)

Reimplemented in MediaWiki\Widget\SearchInputWidget.

Definition at line 30 of file TitleInputWidget.php.

Member Function Documentation

getConfig()

MediaWiki\Widget\TitleInputWidget::getConfig

(

&

$config

)

Reimplemented in MediaWiki\Widget\SearchInputWidget.

Definition at line 60 of file TitleInputWidget.php.

References MediaWiki\Widget\TitleInputWidget\$highlightFirst, MediaWiki\Widget\TitleInputWidget\$namespace, MediaWiki\Widget\TitleInputWidget\$relative, MediaWiki\Widget\TitleInputWidget\$suggestions, and MediaWiki\Widget\TitleInputWidget\$validateTitle.

getJavaScriptClassName()

MediaWiki\Widget\TitleInputWidget::getJavaScriptClassName ( )

protected

Reimplemented in MediaWiki\Widget\SearchInputWidget.

Definition at line 56 of file TitleInputWidget.php.

Member Data Documentation

$highlightFirst

MediaWiki\Widget\TitleInputWidget::$highlightFirst = null

protected

Definition at line 16 of file TitleInputWidget.php.

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

$namespace

MediaWiki\Widget\TitleInputWidget::$namespace = null

protected

Definition at line 13 of file TitleInputWidget.php.

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

$relative

MediaWiki\Widget\TitleInputWidget::$relative = null

protected

Definition at line 14 of file TitleInputWidget.php.

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

$suggestions

MediaWiki\Widget\TitleInputWidget::$suggestions = null

protected

Definition at line 15 of file TitleInputWidget.php.

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

$validateTitle

MediaWiki\Widget\TitleInputWidget::$validateTitle = null

protected

Definition at line 17 of file TitleInputWidget.php.

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

---

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

• includes/widget/TitleInputWidget.php