HTMLRadioField.php

Go to the documentation of this file.

<?php
 
use MediaWiki\Html\Html;
use MediaWiki\MainConfigNames;
 
class HTMLRadioField extends HTMLFormField {
    public function __construct( $params ) {
        parent::__construct( $params );
 
        if ( isset( $params['flatlist'] ) ) {
            $this->mClass .= ' mw-htmlform-flatlist';
        }
    }
 
    public function validate( $value, $alldata ) {
        $p = parent::validate( $value, $alldata );
 
        if ( $p !== true ) {
            return $p;
        }
 
        if ( !is_string( $value ) && !is_int( $value ) ) {
            return $this->msg( 'htmlform-required' );
        }
 
        $validOptions = HTMLFormField::flattenOptions( $this->getOptions() );
 
        if ( in_array( strval( $value ), $validOptions, true ) ) {
            return true;
        } else {
            return $this->msg( 'htmlform-select-badoption' );
        }
    }
 
    public function getInputHTML( $value ) {
        $html = $this->formatOptions( $this->getOptions(), strval( $value ) );
 
        return $html;
    }
 
    public function getInputOOUI( $value ) {
        $options = [];
        foreach ( $this->getOptions() as $label => $data ) {
            $options[] = [
                'data' => $data,
                // @phan-suppress-next-line SecurityCheck-XSS Labels are raw when not from message
                'label' => $this->mOptionsLabelsNotFromMessage ? new OOUI\HtmlSnippet( $label ) : $label,
            ];
        }
 
        return new OOUI\RadioSelectInputWidget( [
            'name' => $this->mName,
            'id' => $this->mID,
            'value' => $value,
            'options' => $options,
        ] + OOUI\Element::configFromHtmlAttributes(
            $this->getAttributes( [ 'disabled', 'tabindex' ] )
        ) );
    }
 
    public function formatOptions( $options, $value ) {
        $useMediaWikiUIEverywhere = $this->mParent->getConfig()->get( MainConfigNames::UseMediaWikiUIEverywhere );
 
        $html = '';
 
        $attribs = $this->getAttributes( [ 'disabled', 'tabindex' ] );
        $elementFunc = [ Html::class, $this->mOptionsLabelsNotFromMessage ? 'rawElement' : 'element' ];
 
        # @todo Should this produce an unordered list perhaps?
        foreach ( $options as $label => $info ) {
            if ( is_array( $info ) ) {
                $html .= Html::rawElement( 'h1', [], $label ) . "\n";
                $html .= $this->formatOptions( $info, $value );
            } else {
                $id = Sanitizer::escapeIdForAttribute( $this->mID . "-$info" );
                $classes = [ 'mw-htmlform-flatlist-item' ];
                if ( $useMediaWikiUIEverywhere || $this->mParent instanceof VFormHTMLForm ) {
                    $classes[] = 'mw-ui-radio';
                }
                $radio = Xml::radio( $this->mName, $info, $info === $value, $attribs + [ 'id' => $id ] );
                $radio .= "\u{00A0}" . call_user_func( $elementFunc, 'label', [ 'for' => $id ], $label );
 
                $html .= ' ' . Html::rawElement(
                    'div',
                    [ 'class' => $classes ],
                    $radio
                );
            }
        }
 
        return $html;
    }
 
    protected function needsLabel() {
        return false;
    }
}