HTMLTitleTextField.php

Go to the documentation of this file.

<?php
 
use MediaWiki\Widget\TitleInputWidget;
 
class HTMLTitleTextField extends HTMLTextField {
    public function __construct( $params ) {
        $params += [
            'namespace' => false,
            'relative' => false,
            'creatable' => false,
            'exists' => false,
            // Default to null during the deprecation process so we can differentiate between
            // callers who intentionally want to disallow interwiki titles and legacy callers
            // who aren't aware of the setting.
            'interwiki' => null,
            // This overrides the default from HTMLFormField
            'required' => true,
        ];
 
        parent::__construct( $params );
    }
 
    public function validate( $value, $alldata ) {
        if ( $this->mParams['interwiki'] && $this->mParams['relative'] ) {
            // relative and interwiki cannot be used together, because we don't have a way to know about
            // namespaces used by the other wiki (and it might actually be a non-wiki link, too).
            throw new InvalidArgumentException( 'relative and interwiki may not be used together' );
        }
        // Default value (from getDefault()) is null, which breaks Title::newFromTextThrow() below
        if ( $value === null ) {
            $value = '';
        }
 
        if ( !$this->mParams['required'] && $value === '' ) {
            // If this field is not required and the value is empty, that's okay, skip validation
            return parent::validate( $value, $alldata );
        }
 
        try {
            if ( !$this->mParams['relative'] ) {
                $title = Title::newFromTextThrow( $value );
            } else {
                // Can't use Title::makeTitleSafe(), because it doesn't throw useful exceptions
                $title = Title::newFromTextThrow( Title::makeName( $this->mParams['namespace'], $value ) );
            }
        } catch ( MalformedTitleException $e ) {
            return $this->msg( $e->getErrorMessage(), $e->getErrorMessageParameters() );
        }
 
        if ( $title->isExternal() ) {
            if ( $this->mParams['interwiki'] ) {
                // We cannot validate external titles, skip the rest of the validation
                return parent::validate( $value, $alldata );
            } elseif ( $this->mParams['interwiki'] === null ) {
                // Legacy caller, they probably don't need/want interwiki titles as those don't
                // make sense in most use cases. To avoid a B/C break without deprecation, though,
                // we let the title through and raise a warning. That way, code that needs to allow
                // interwiki titles will get deprecation warnings as long as users actually submit
                // interwiki titles to the form. That's not ideal but a less conditional warning
                // would be impractical - having to update every title field in the world to avoid
                // warnings would be too much of a burden.
                wfDeprecated(
                    __METHOD__ . ' will reject external titles in 1.38 when interwiki is false '
                        . "(field: $this->mName)",
                    '1.37'
                );
                return parent::validate( $value, $alldata );
            } else {
                return $this->msg( 'htmlform-title-interwiki', $title->getPrefixedText() );
            }
        }
 
        $text = $title->getPrefixedText();
        if ( $this->mParams['namespace'] !== false &&
            !$title->inNamespace( $this->mParams['namespace'] )
        ) {
            return $this->msg( 'htmlform-title-badnamespace', $text, $this->mParams['namespace'] );
        }
 
        if ( $this->mParams['creatable'] && !$title->canExist() ) {
            return $this->msg( 'htmlform-title-not-creatable', $text );
        }
 
        if ( $this->mParams['exists'] && !$title->exists() ) {
            return $this->msg( 'htmlform-title-not-exists', $text );
        }
 
        return parent::validate( $value, $alldata );
    }
 
    protected function getInputWidget( $params ) {
        if ( $this->mParams['namespace'] !== false ) {
            $params['namespace'] = $this->mParams['namespace'];
        }
        $params['relative'] = $this->mParams['relative'];
        return new TitleInputWidget( $params );
    }
 
    protected function shouldInfuseOOUI() {
        return true;
    }
 
    protected function getOOUIModules() {
        // FIXME: TitleInputWidget should be in its own module
        return [ 'mediawiki.widgets' ];
    }
 
    public function getInputHtml( $value ) {
        // add mw-searchInput class to enable search suggestions for non-OOUI, too
        $this->mClass .= 'mw-searchInput';
 
        // return the HTMLTextField html
        return parent::getInputHTML( $value );
    }
 
    protected function getDataAttribs() {
        return [
            'data-mw-searchsuggest' => FormatJson::encode( [
                'wrapAsLink' => false,
            ] ),
        ];
    }
}