SearchInputWidget.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Widget;
 
use OOUI\Tag;
 
class SearchInputWidget extends TitleInputWidget {
 
    protected $performSearchOnClick = true;
    protected $validateTitle = false;
    protected $highlightFirst = false;
    protected $dataLocation = 'header';
    protected $showDescriptions = false;
 
    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 );
    }
}