HTMLUserTextField.php

Go to the documentation of this file.

<?php
 
use MediaWiki\Widget\UserInputWidget;
 
class HTMLUserTextField extends HTMLTextField {
    public function __construct( $params ) {
        $params += [
            'exists' => false,
            'ipallowed' => false,
        ];
 
        parent::__construct( $params );
    }
 
    public function validate( $value, $alldata ) {
        // check, if a user exists with the given username
        $user = User::newFromName( $value, false );
 
        if ( !$user ) {
            return $this->msg( 'htmlform-user-not-valid', $value );
        } elseif (
            ( $this->mParams['exists'] && $user->getId() === 0 ) &&
            !( $this->mParams['ipallowed'] && User::isIP( $value ) )
        ) {
            return $this->msg( 'htmlform-user-not-exists', $user->getName() );
        }
 
        return parent::validate( $value, $alldata );
    }
 
    protected function getInputWidget( $params ) {
        return new UserInputWidget( $params );
    }
 
    protected function shouldInfuseOOUI() {
        return true;
    }
 
    protected function getOOUIModules() {
        return [ 'mediawiki.widgets.UserInputWidget' ];
    }
 
    public function getInputHtml( $value ) {
        // add the required module and css class for user suggestions in non-OOUI mode
        $this->mParent->getOutput()->addModules( 'mediawiki.userSuggest' );
        $this->mClass .= ' mw-autocomplete-user';
 
        // return parent html
        return parent::getInputHTML( $value );
    }
}