bbc74d93b0
This patch refactors various widget classes in the includes/widget directory to use cleaner namespacing. The patches remove redundant backslash prefixes in class extending statements and add use statements for OOUI classes and other MediaWiki-specific classes. This patch improves readability and maintainability of the code by following the MediaWiki coding conventions and leverages the benefits of PHP's namespacing system. List of affected classes: - CheckMatrixWidget - DateInputWidget - DateTimeInputWidget - NamespaceInputWidget - SearchInputWidget - SelectWithInputWidget - SizeFilterWidget - SpinnerWidget - TagMultiselectWidget - TitleInputWidget - UserInputWidget Additionally, the code now correctly documents exceptions thrown by constructors where missing, enforcing clearer developer expectations. Change-Id: I0fdaf68a412a1c3b7049a79222f4dbeaa95a6bbc
79 lines
2.2 KiB
PHP
79 lines
2.2 KiB
PHP
<?php
|
|
|
|
namespace MediaWiki\Widget;
|
|
|
|
use OOUI\Tag;
|
|
|
|
/**
|
|
* Search input widget.
|
|
*
|
|
* @copyright 2011-2015 MediaWiki Widgets Team and others; see AUTHORS.txt
|
|
* @license MIT
|
|
*/
|
|
class SearchInputWidget extends TitleInputWidget {
|
|
|
|
protected $performSearchOnClick = true;
|
|
protected $validateTitle = false;
|
|
protected $highlightFirst = false;
|
|
protected $dataLocation = 'header';
|
|
protected $showDescriptions = false;
|
|
|
|
/**
|
|
* @param array $config Configuration 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)
|
|
*/
|
|
public function __construct( array $config = [] ) {
|
|
$config = array_merge( [
|
|
'maxLength' => null,
|
|
'icon' => 'search',
|
|
], $config );
|
|
|
|
parent::__construct( $config );
|
|
|
|
// Properties, which are ignored in PHP and just shipped back to JS
|
|
if ( isset( $config['performSearchOnClick'] ) ) {
|
|
$this->performSearchOnClick = $config['performSearchOnClick'];
|
|
}
|
|
|
|
if ( isset( $config['dataLocation'] ) ) {
|
|
// identifies the location of the search bar for tracking purposes
|
|
$this->dataLocation = $config['dataLocation'];
|
|
}
|
|
|
|
if ( !empty( $config['showDescriptions'] ) ) {
|
|
$this->showDescriptions = true;
|
|
}
|
|
|
|
// Perhaps should be upstreamed to TextInputWidget?
|
|
if ( isset( $config['autocapitalize'] ) ) {
|
|
$this->input->setAttributes( [ 'autocapitalize' => $config['autocapitalize'] ] );
|
|
}
|
|
|
|
// Initialization
|
|
$this->addClasses( [ 'mw-widget-searchInputWidget' ] );
|
|
}
|
|
|
|
protected function getInputElement( $config ) {
|
|
return ( new Tag( 'input' ) )->setAttributes( [ 'type' => 'search' ] );
|
|
}
|
|
|
|
protected function getJavaScriptClassName() {
|
|
return 'mw.widgets.SearchInputWidget';
|
|
}
|
|
|
|
public function getConfig( &$config ) {
|
|
$config['performSearchOnClick'] = $this->performSearchOnClick;
|
|
if ( $this->dataLocation ) {
|
|
$config['dataLocation'] = $this->dataLocation;
|
|
}
|
|
if ( $this->showDescriptions ) {
|
|
$config['showDescriptions'] = true;
|
|
}
|
|
$config['$overlay'] = true;
|
|
return parent::getConfig( $config );
|
|
}
|
|
}
|