HTMLRadioField.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\HTMLForm\Field;
 
use InvalidArgumentException;
use MediaWiki\Html\Html;
use MediaWiki\HTMLForm\HTMLFormField;
use MediaWiki\Parser\Sanitizer;
use MediaWiki\Xml\Xml;
 
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 ) {
        if (
            isset( $this->mParams['option-descriptions'] ) ||
            isset( $this->mParams['option-descriptions-messages'] ) ) {
            throw new InvalidArgumentException(
                "Non-Codex HTMLForms do not support the 'option-descriptions' parameter for radio buttons"
            );
        }
 
        $html = $this->formatOptions( $this->getOptions(), strval( $value ) );
 
        return $html;
    }
 
    public function getInputOOUI( $value ) {
        if (
            isset( $this->mParams['option-descriptions'] ) ||
            isset( $this->mParams['option-descriptions-messages'] ) ) {
            throw new InvalidArgumentException(
                "Non-Codex HTMLForms do not support the 'option-descriptions' parameter for radio buttons"
            );
        }
 
        $options = [];
        foreach ( $this->getOptions() as $label => $data ) {
            if ( is_int( $label ) ) {
                $label = strval( $label );
            }
            $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 getInputCodex( $value, $hasErrors ) {
        $optionDescriptions = $this->getOptionDescriptions();
        $html = '';
 
        // Iterate over an array of options and return the HTML markup.
        foreach ( $this->getOptions() as $label => $radioValue ) {
            $description = $optionDescriptions[$radioValue] ?? '';
            $descriptionID = Sanitizer::escapeIdForAttribute(
                $this->mID . "-$radioValue-description"
            );
 
            // Attributes for the radio input.
            $radioInputClasses = [ 'cdx-radio__input' ];
            $radioInputAttribs = [
                'id' => Sanitizer::escapeIdForAttribute( $this->mID . "-$radioValue" ),
                'type' => 'radio',
                'name' => $this->mName,
                'class' => $radioInputClasses,
                'value' => $radioValue
            ];
            $radioInputAttribs += $this->getAttributes( [ 'disabled', 'tabindex' ] );
            if ( $description ) {
                $radioInputAttribs['aria-describedby'] = $descriptionID;
            }
 
            // Set the selected value as "checked".
            if ( $radioValue === $value ) {
                $radioInputAttribs['checked'] = true;
            }
 
            // Attributes for the radio icon.
            $radioIconClasses = [ 'cdx-radio__icon' ];
            $radioIconAttribs = [
                'class' => $radioIconClasses,
            ];
 
            // Attributes for the radio label.
            $radioLabelClasses = [ 'cdx-label__label' ];
            $radioLabelAttribs = [
                'class' => $radioLabelClasses,
                'for' => $radioInputAttribs['id']
            ];
 
            // HTML markup for radio input, radio icon, and radio label elements.
            $radioInput = Html::element( 'input', $radioInputAttribs );
            $radioIcon = Html::element( 'span', $radioIconAttribs );
            $radioLabel = $this->mOptionsLabelsNotFromMessage
                ? Html::rawElement( 'label', $radioLabelAttribs, $label )
                : Html::element( 'label', $radioLabelAttribs, $label );
 
            $radioDescription = '';
            if ( isset( $optionDescriptions[$radioValue] ) ) {
                $radioDescription = Html::rawElement(
                    'span',
                    [ 'id' => $descriptionID, 'class' => 'cdx-label__description' ],
                    $optionDescriptions[$radioValue]
                );
            }
            $radioLabelWrapper = Html::rawElement(
                'div',
                [ 'class' => 'cdx-radio__label cdx-label' ],
                $radioLabel . $radioDescription
            );
 
            // HTML markup for CSS-only Codex Radio.
            $radio = Html::rawElement(
                'span',
                [ 'class' => 'cdx-radio' ],
                $radioInput . $radioIcon . $radioLabelWrapper
            );
 
            // Append the Codex Radio HTML markup to the initialized empty string variable.
            $html .= $radio;
        }
 
        return $html;
    }
 
    public function formatOptions( $options, $value ) {
        $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' ];
                $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 getOptionDescriptions() {
        if ( array_key_exists( 'option-descriptions-messages', $this->mParams ) ) {
            $needsParse = $this->mParams['option-descriptions-messages-parse'] ?? false;
            $optionDescriptions = [];
            foreach ( $this->mParams['option-descriptions-messages'] as $value => $msgKey ) {
                $msg = $this->msg( $msgKey );
                $optionDescriptions[$value] = $needsParse ? $msg->parse() : $msg->escaped();
            }
            return $optionDescriptions;
        } elseif ( array_key_exists( 'option-descriptions', $this->mParams ) ) {
            return $this->mParams['option-descriptions'];
        }
    }
 
    protected function needsLabel() {
        return false;
    }
}
 
class_alias( HTMLRadioField::class, 'HTMLRadioField' );