includes/widget/SearchInputWidget.php

   1 <?php
   2 /**
   3  * MediaWiki Widgets – SearchInputWidget class.
   4  *
   5  * @copyright 2011-2015 MediaWiki Widgets Team and others; see AUTHORS.txt
   6  * @license The MIT License (MIT); see LICENSE.txt
   7  */
   8 namespace MediaWiki\Widget;
   9
  10 /**
  11  * Search input widget.
  12  */
  13 class SearchInputWidget extends \OOUI\TextInputWidget {
  14
  15         protected $pushPending = false;
  16         protected $performSearchOnClick = true;
  17         protected $dataLocation = 'header';
  18
  19         /**
  20          * @param array $config Configuration options
  21          * @param int|null $config['pushPending'] Whether the input should be visually marked as
  22          *  "pending", while requesting suggestions (default: false)
  23          * @param boolean|null $config['performSearchOnClick'] If true, the script will start a search
  24          *  whenever a user hits a suggestion. If false, the text of the suggestion is inserted into the
  25          *  text field only (default: true)
  26          * @param string $config['dataLocation'] Where the search input field will be
  27          *  used (header or content, default: header)
  28          */
  29         public function __construct( array $config = [] ) {
  30                 $config = array_merge( [
  31                         'icon' => 'search',
  32                 ], $config );
  33
  34                 // Parent constructor
  35                 parent::__construct( $config );
  36
  37                 // Properties, which are ignored in PHP and just shipped back to JS
  38                 if ( isset( $config['pushPending'] ) ) {
  39                         $this->pushPending = $config['pushPending'];
  40                 }
  41
  42                 if ( isset( $config['performSearchOnClick'] ) ) {
  43                         $this->performSearchOnClick = $config['performSearchOnClick'];
  44                 }
  45
  46                 if ( isset( $config['dataLocation'] ) ) {
  47                         // identifies the location of the search bar for tracking purposes
  48                         $this->dataLocation = $config['dataLocation'];
  49                 }
  50
  51                 // Initialization
  52                 $this->addClasses( [ 'mw-widget-searchInputWidget' ] );
  53         }
  54
  55         protected function getInputElement( $config ) {
  56                 return ( new \OOUI\Tag( 'input' ) )->setAttributes( [ 'type' => 'search' ] );
  57         }
  58
  59         protected function getJavaScriptClassName() {
  60                 return 'mw.widgets.SearchInputWidget';
  61         }
  62
  63         public function getConfig( &$config ) {
  64                 $config['pushPending'] = $this->pushPending;
  65                 $config['performSearchOnClick'] = $this->performSearchOnClick;
  66                 if ( $this->dataLocation ) {
  67                         $config['dataLocation'] = $this->dataLocation;
  68                 }
  69                 return parent::getConfig( $config );
  70         }
  71 }