includes/htmlform/fields/HTMLRadioField.php

   1 <?php
   2
   3 /**
   4  * Radio checkbox fields.
   5  */
   6 class HTMLRadioField extends HTMLFormField {
   7         /**
   8          * @param array $params
   9          *   In adition to the usual HTMLFormField parameters, this can take the following fields:
  10          *   - flatlist: If given, the options will be displayed on a single line (wrapping to following
  11          *     lines if necessary), rather than each one on a line of its own. This is desirable mostly
  12          *     for very short lists of concisely labelled options.
  13          */
  14         public function __construct( $params ) {
  15                 parent::__construct( $params );
  16
  17                 if ( isset( $params['flatlist'] ) ) {
  18                         $this->mClass .= ' mw-htmlform-flatlist';
  19                 }
  20         }
  21
  22         public function validate( $value, $alldata ) {
  23                 $p = parent::validate( $value, $alldata );
  24
  25                 if ( $p !== true ) {
  26                         return $p;
  27                 }
  28
  29                 if ( !is_string( $value ) && !is_int( $value ) ) {
  30                         return $this->msg( 'htmlform-required' );
  31                 }
  32
  33                 $validOptions = HTMLFormField::flattenOptions( $this->getOptions() );
  34
  35                 if ( in_array( strval( $value ), $validOptions, true ) ) {
  36                         return true;
  37                 } else {
  38                         return $this->msg( 'htmlform-select-badoption' );
  39                 }
  40         }
  41
  42         /**
  43          * This returns a block of all the radio options, in one cell.
  44          * @see includes/HTMLFormField#getInputHTML()
  45          *
  46          * @param string $value
  47          *
  48          * @return string
  49          */
  50         public function getInputHTML( $value ) {
  51                 $html = $this->formatOptions( $this->getOptions(), strval( $value ) );
  52
  53                 return $html;
  54         }
  55
  56         public function getInputOOUI( $value ) {
  57                 $options = [];
  58                 foreach ( $this->getOptions() as $label => $data ) {
  59                         $options[] = [
  60                                 'data' => $data,
  61                                 'label' => $this->mOptionsLabelsNotFromMessage ? new OOUI\HtmlSnippet( $label ) : $label,
  62                         ];
  63                 }
  64
  65                 return new OOUI\RadioSelectInputWidget( [
  66                         'name' => $this->mName,
  67                         'id' => $this->mID,
  68                         'value' => $value,
  69                         'options' => $options,
  70                 ] + OOUI\Element::configFromHtmlAttributes(
  71                         $this->getAttributes( [ 'disabled', 'tabindex' ] )
  72                 ) );
  73         }
  74
  75         public function formatOptions( $options, $value ) {
  76                 global $wgUseMediaWikiUIEverywhere;
  77
  78                 $html = '';
  79
  80                 $attribs = $this->getAttributes( [ 'disabled', 'tabindex' ] );
  81                 $elementFunc = [ Html::class, $this->mOptionsLabelsNotFromMessage ? 'rawElement' : 'element' ];
  82
  83                 # @todo Should this produce an unordered list perhaps?
  84                 foreach ( $options as $label => $info ) {
  85                         if ( is_array( $info ) ) {
  86                                 $html .= Html::rawElement( 'h1', [], $label ) . "\n";
  87                                 $html .= $this->formatOptions( $info, $value );
  88                         } else {
  89                                 $id = Sanitizer::escapeIdForAttribute( $this->mID . "-$info" );
  90                                 $classes = [ 'mw-htmlform-flatlist-item' ];
  91                                 if ( $wgUseMediaWikiUIEverywhere || $this->mParent instanceof VFormHTMLForm ) {
  92                                         $classes[] = 'mw-ui-radio';
  93                                 }
  94                                 $radio = Xml::radio( $this->mName, $info, $info === $value, $attribs + [ 'id' => $id ] );
  95                                 $radio .= '&#160;' . call_user_func( $elementFunc, 'label', [ 'for' => $id ], $label );
  96
  97                                 $html .= ' ' . Html::rawElement(
  98                                         'div',
  99                                         [ 'class' => $classes ],
 100                                         $radio
 101                                 );
 102                         }
 103                 }
 104
 105                 return $html;
 106         }
 107
 108         protected function needsLabel() {
 109                 return false;
 110         }
 111 }