wiki.techinc.nl/includes/widget/SearchInputWidget.php
Florian 36784f7c35 Search: Change dataLocation default value and add docs
Implemented Krinkle's comments of the followed up commit.

Follow up I2480149

Change-Id: I8e51c0d3a3ca1690ea3ea08469a1cd52d9c151f3
2016-05-06 12:18:19 +00:00

72 lines
2.2 KiB
PHP
Executable file
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?php
/**
* MediaWiki Widgets SearchInputWidget class.
*
* @copyright 2011-2015 MediaWiki Widgets Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
namespace MediaWiki\Widget;
/**
* Search input widget.
*/
class SearchInputWidget extends TitleInputWidget {
protected $pushPending = false;
protected $performSearchOnClick = true;
protected $validateTitle = false;
protected $highlightFirst = false;
protected $dataLocation = 'header';
/**
* @param array $config Configuration options
* @param int|null $config['pushPending'] Whether the input should be visually marked as
* "pending", while requesting suggestions (default: true)
* @param boolean|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)
* @param string $config['dataLocation'] Where the search input field will be
* used (header or content, default: header)
*/
public function __construct( array $config = [] ) {
$config = array_merge( [
'infusable' => true,
'maxLength' => null,
'type' => 'search',
'icon' => 'search',
], $config );
// Parent constructor
parent::__construct( $config );
// Properties, which are ignored in PHP and just shipped back to JS
if ( isset( $config['pushPending'] ) ) {
$this->pushPending = $config['pushPending'];
}
if ( isset( $config['performSearchOnClick'] ) ) {
$this->performSearchOnClick = $config['performSearchOnClick'];
}
if ( $config['dataLocation'] ) {
// identifies the location of the search bar for tracking purposes
$this->dataLocation = $config['dataLocation'];
}
// Initialization
$this->addClasses( [ 'mw-widget-searchInputWidget' ] );
}
protected function getJavaScriptClassName() {
return 'mw.widgets.SearchInputWidget';
}
public function getConfig( &$config ) {
$config['pushPending'] = $this->pushPending;
$config['performSearchOnClick'] = $this->performSearchOnClick;
if ( $this->dataLocation ) {
$config['dataLocation'] = $this->dataLocation;
}
return parent::getConfig( $config );
}
}