MediaWiki master
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
MediaWiki\Widget\TitleInputWidget Class Reference

Title input widget. More...

Inherits TextInputWidget.

Inherited by MediaWiki\Widget\SearchInputWidget.

Collaboration diagram for MediaWiki\Widget\TitleInputWidget:
Collaboration graph
[legend]

Public Member Functions

 __construct (array $config=[])
 
 getConfig (&$config)
 

Protected Member Functions

 getJavaScriptClassName ()
 

Protected Attributes

bool null $creatable = null
 
bool null $highlightFirst = null
 
int null $namespace = null
 
bool null $relative = null
 
bool null $suggestions = null
 
bool null $validateTitle = null
 

Detailed Description

Title input widget.

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

Definition at line 13 of file TitleInputWidget.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Widget\TitleInputWidget::__construct ( array $config = [])
Parameters
array$configConfiguration 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)
  • bool|null $config['creatable'] Whether to validate the title is creatable (not a special page) (default: false)

Reimplemented in MediaWiki\Widget\SearchInputWidget.

Definition at line 41 of file TitleInputWidget.php.

Member Function Documentation

◆ getConfig()

MediaWiki\Widget\TitleInputWidget::getConfig ( & $config)

Reimplemented in MediaWiki\Widget\SearchInputWidget.

Definition at line 76 of file TitleInputWidget.php.

References MediaWiki\Widget\TitleInputWidget\$creatable, 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 71 of file TitleInputWidget.php.

Member Data Documentation

◆ $creatable

bool null MediaWiki\Widget\TitleInputWidget::$creatable = null
protected

Definition at line 26 of file TitleInputWidget.php.

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

◆ $highlightFirst

bool null MediaWiki\Widget\TitleInputWidget::$highlightFirst = null
protected

Definition at line 22 of file TitleInputWidget.php.

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

◆ $namespace

int null MediaWiki\Widget\TitleInputWidget::$namespace = null
protected

Definition at line 16 of file TitleInputWidget.php.

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

◆ $relative

bool null MediaWiki\Widget\TitleInputWidget::$relative = null
protected

Definition at line 18 of file TitleInputWidget.php.

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

◆ $suggestions

bool null MediaWiki\Widget\TitleInputWidget::$suggestions = null
protected

Definition at line 20 of file TitleInputWidget.php.

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

◆ $validateTitle

bool null MediaWiki\Widget\TitleInputWidget::$validateTitle = null
protected

Definition at line 24 of file TitleInputWidget.php.

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

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