includes/htmlform/HTMLRadioField.php

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