aboutsummaryrefslogtreecommitdiffstats
path: root/includes/widget/SearchInputWidget.php
blob: 5b26f333296796922468ef5425f588d6f7f95a2f (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
<?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 {

	/** @var bool */
	protected $performSearchOnClick = true;
	/** @var bool */
	protected $validateTitle = false;
	/** @var bool */
	protected $highlightFirst = false;
	/** @var string */
	protected $dataLocation = 'header';
	/** @var bool */
	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 );
		'@phan-var array $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 );
	}
}