includes/htmlform/HTMLFormField.php

   1 <?php
   2
   3 /**
   4  * The parent class to generate form fields.  Any field type should
   5  * be a subclass of this.
   6  */
   7 abstract class HTMLFormField {
   8         public $mParams;
   9
  10         protected $mValidationCallback;
  11         protected $mFilterCallback;
  12         protected $mName;
  13         protected $mDir;
  14         protected $mLabel; # String label.  Set on construction
  15         protected $mID;
  16         protected $mClass = '';
  17         protected $mVFormClass = '';
  18         protected $mHelpClass = false;
  19         protected $mDefault;
  20         protected $mOptions = false;
  21         protected $mOptionsLabelsNotFromMessage = false;
  22         protected $mHideIf = null;
  23
  24         /**
  25          * @var bool If true will generate an empty div element with no label
  26          * @since 1.22
  27          */
  28         protected $mShowEmptyLabels = true;
  29
  30         /**
  31          * @var HTMLForm
  32          */
  33         public $mParent;
  34
  35         /**
  36          * This function must be implemented to return the HTML to generate
  37          * the input object itself.  It should not implement the surrounding
  38          * table cells/rows, or labels/help messages.
  39          *
  40          * @param string $value The value to set the input to; eg a default
  41          *     text for a text input.
  42          *
  43          * @return string Valid HTML.
  44          */
  45         abstract function getInputHTML( $value );
  46
  47         /**
  48          * Same as getInputHTML, but returns an OOUI object.
  49          * Defaults to false, which getOOUI will interpret as "use the HTML version"
  50          *
  51          * @param string $value
  52          * @return OOUI\Widget|false
  53          */
  54         function getInputOOUI( $value ) {
  55                 return false;
  56         }
  57
  58         /**
  59          * Get a translated interface message
  60          *
  61          * This is a wrapper around $this->mParent->msg() if $this->mParent is set
  62          * and wfMessage() otherwise.
  63          *
  64          * Parameters are the same as wfMessage().
  65          *
  66          * @return Message
  67          */
  68         function msg() {
  69                 $args = func_get_args();
  70
  71                 if ( $this->mParent ) {
  72                         $callback = array( $this->mParent, 'msg' );
  73                 } else {
  74                         $callback = 'wfMessage';
  75                 }
  76
  77                 return call_user_func_array( $callback, $args );
  78         }
  79
  80
  81         /**
  82          * Fetch a field value from $alldata for the closest field matching a given
  83          * name.
  84          *
  85          * This is complex because it needs to handle array fields like the user
  86          * would expect. The general algorithm is to look for $name as a sibling
  87          * of $this, then a sibling of $this's parent, and so on. Keeping in mind
  88          * that $name itself might be referencing an array.
  89          *
  90          * @param array $alldata
  91          * @param string $name
  92          * @return string
  93          */
  94         protected function getNearestFieldByName( $alldata, $name ) {
  95                 $tmp = $this->mName;
  96                 $thisKeys = array();
  97                 while ( preg_match( '/^(.+)\[([^\]]+)\]$/', $tmp, $m ) ) {
  98                         array_unshift( $thisKeys, $m[2] );
  99                         $tmp = $m[1];
 100                 }
 101                 if ( substr( $tmp, 0, 2 ) == 'wp' &&
 102                         !isset( $alldata[$tmp] ) &&
 103                         isset( $alldata[substr( $tmp, 2 )] )
 104                 ) {
 105                         // Adjust for name mangling.
 106                         $tmp = substr( $tmp, 2 );
 107                 }
 108                 array_unshift( $thisKeys, $tmp );
 109
 110                 $tmp = $name;
 111                 $nameKeys = array();
 112                 while ( preg_match( '/^(.+)\[([^\]]+)\]$/', $tmp, $m ) ) {
 113                         array_unshift( $nameKeys, $m[2] );
 114                         $tmp = $m[1];
 115                 }
 116                 array_unshift( $nameKeys, $tmp );
 117
 118                 $testValue = '';
 119                 for ( $i = count( $thisKeys ) - 1; $i >= 0; $i-- ) {
 120                         $keys = array_merge( array_slice( $thisKeys, 0, $i ), $nameKeys );
 121                         $data = $alldata;
 122                         while ( $keys ) {
 123                                 $key = array_shift( $keys );
 124                                 if ( !is_array( $data ) || !isset( $data[$key] ) ) {
 125                                         continue 2;
 126                                 }
 127                                 $data = $data[$key];
 128                         }
 129                         $testValue = (string)$data;
 130                         break;
 131                 }
 132
 133                 return $testValue;
 134         }
 135
 136         /**
 137          * Helper function for isHidden to handle recursive data structures.
 138          *
 139          * @param array $alldata
 140          * @param array $params
 141          * @return bool
 142          * @throws MWException
 143          */
 144         protected function isHiddenRecurse( array $alldata, array $params ) {
 145                 $origParams = $params;
 146                 $op = array_shift( $params );
 147
 148                 try {
 149                         switch ( $op ) {
 150                                 case 'AND':
 151                                         foreach ( $params as $i => $p ) {
 152                                                 if ( !is_array( $p ) ) {
 153                                                         throw new MWException(
 154                                                                 "Expected array, found " . gettype( $p ) . " at index $i"
 155                                                         );
 156                                                 }
 157                                                 if ( !$this->isHiddenRecurse( $alldata, $p ) ) {
 158                                                         return false;
 159                                                 }
 160                                         }
 161                                         return true;
 162
 163                                 case 'OR':
 164                                         foreach ( $params as $p ) {
 165                                                 if ( !is_array( $p ) ) {
 166                                                         throw new MWException(
 167                                                                 "Expected array, found " . gettype( $p ) . " at index $i"
 168                                                         );
 169                                                 }
 170                                                 if ( $this->isHiddenRecurse( $alldata, $p ) ) {
 171                                                         return true;
 172                                                 }
 173                                         }
 174                                         return false;
 175
 176                                 case 'NAND':
 177                                         foreach ( $params as $i => $p ) {
 178                                                 if ( !is_array( $p ) ) {
 179                                                         throw new MWException(
 180                                                                 "Expected array, found " . gettype( $p ) . " at index $i"
 181                                                         );
 182                                                 }
 183                                                 if ( !$this->isHiddenRecurse( $alldata, $p ) ) {
 184                                                         return true;
 185                                                 }
 186                                         }
 187                                         return false;
 188
 189                                 case 'NOR':
 190                                         foreach ( $params as $p ) {
 191                                                 if ( !is_array( $p ) ) {
 192                                                         throw new MWException(
 193                                                                 "Expected array, found " . gettype( $p ) . " at index $i"
 194                                                         );
 195                                                 }
 196                                                 if ( $this->isHiddenRecurse( $alldata, $p ) ) {
 197                                                         return false;
 198                                                 }
 199                                         }
 200                                         return true;
 201
 202                                 case 'NOT':
 203                                         if ( count( $params ) !== 1 ) {
 204                                                 throw new MWException( "NOT takes exactly one parameter" );
 205                                         }
 206                                         $p = $params[0];
 207                                         if ( !is_array( $p ) ) {
 208                                                 throw new MWException(
 209                                                         "Expected array, found " . gettype( $p ) . " at index 0"
 210                                                 );
 211                                         }
 212                                         return !$this->isHiddenRecurse( $alldata, $p );
 213
 214                                 case '===':
 215                                 case '!==':
 216                                         if ( count( $params ) !== 2 ) {
 217                                                 throw new MWException( "$op takes exactly two parameters" );
 218                                         }
 219                                         list( $field, $value ) = $params;
 220                                         if ( !is_string( $field ) || !is_string( $value ) ) {
 221                                                 throw new MWException( "Parameters for $op must be strings" );
 222                                         }
 223                                         $testValue = $this->getNearestFieldByName( $alldata, $field );
 224                                         switch ( $op ) {
 225                                                 case '===':
 226                                                         return ( $value === $testValue );
 227                                                 case '!==':
 228                                                         return ( $value !== $testValue );
 229                                         }
 230
 231                                 default:
 232                                         throw new MWException( "Unknown operation" );
 233                         }
 234                 } catch ( Exception $ex ) {
 235                         throw new MWException(
 236                                 "Invalid hide-if specification for $this->mName: " .
 237                                 $ex->getMessage() . " in " . var_export( $origParams, true ),
 238                                 0, $ex
 239                         );
 240                 }
 241         }
 242
 243         /**
 244          * Test whether this field is supposed to be hidden, based on the values of
 245          * the other form fields.
 246          *
 247          * @since 1.23
 248          * @param array $alldata The data collected from the form
 249          * @return bool
 250          */
 251         function isHidden( $alldata ) {
 252                 if ( !$this->mHideIf ) {
 253                         return false;
 254                 }
 255
 256                 return $this->isHiddenRecurse( $alldata, $this->mHideIf );
 257         }
 258
 259         /**
 260          * Override this function if the control can somehow trigger a form
 261          * submission that shouldn't actually submit the HTMLForm.
 262          *
 263          * @since 1.23
 264          * @param string|array $value The value the field was submitted with
 265          * @param array $alldata The data collected from the form
 266          *
 267          * @return bool True to cancel the submission
 268          */
 269         function cancelSubmit( $value, $alldata ) {
 270                 return false;
 271         }
 272
 273         /**
 274          * Override this function to add specific validation checks on the
 275          * field input.  Don't forget to call parent::validate() to ensure
 276          * that the user-defined callback mValidationCallback is still run
 277          *
 278          * @param string|array $value The value the field was submitted with
 279          * @param array $alldata The data collected from the form
 280          *
 281          * @return bool|string True on success, or String error to display, or
 282          *   false to fail validation without displaying an error.
 283          */
 284         function validate( $value, $alldata ) {
 285                 if ( $this->isHidden( $alldata ) ) {
 286                         return true;
 287                 }
 288
 289                 if ( isset( $this->mParams['required'] )
 290                         && $this->mParams['required'] !== false
 291                         && $value === ''
 292                 ) {
 293                         return $this->msg( 'htmlform-required' )->parse();
 294                 }
 295
 296                 if ( isset( $this->mValidationCallback ) ) {
 297                         return call_user_func( $this->mValidationCallback, $value, $alldata, $this->mParent );
 298                 }
 299
 300                 return true;
 301         }
 302
 303         function filter( $value, $alldata ) {
 304                 if ( isset( $this->mFilterCallback ) ) {
 305                         $value = call_user_func( $this->mFilterCallback, $value, $alldata, $this->mParent );
 306                 }
 307
 308                 return $value;
 309         }
 310
 311         /**
 312          * Should this field have a label, or is there no input element with the
 313          * appropriate id for the label to point to?
 314          *
 315          * @return bool True to output a label, false to suppress
 316          */
 317         protected function needsLabel() {
 318                 return true;
 319         }
 320
 321         /**
 322          * Tell the field whether to generate a separate label element if its label
 323          * is blank.
 324          *
 325          * @since 1.22
 326          *
 327          * @param bool $show Set to false to not generate a label.
 328          * @return void
 329          */
 330         public function setShowEmptyLabel( $show ) {
 331                 $this->mShowEmptyLabels = $show;
 332         }
 333
 334         /**
 335          * Get the value that this input has been set to from a posted form,
 336          * or the input's default value if it has not been set.
 337          *
 338          * @param WebRequest $request
 339          * @return string The value
 340          */
 341         function loadDataFromRequest( $request ) {
 342                 if ( $request->getCheck( $this->mName ) ) {
 343                         return $request->getText( $this->mName );
 344                 } else {
 345                         return $this->getDefault();
 346                 }
 347         }
 348
 349         /**
 350          * Initialise the object
 351          *
 352          * @param array $params Associative Array. See HTMLForm doc for syntax.
 353          *
 354          * @since 1.22 The 'label' attribute no longer accepts raw HTML, use 'label-raw' instead
 355          * @throws MWException
 356          */
 357         function __construct( $params ) {
 358                 $this->mParams = $params;
 359
 360                 if ( isset( $params['parent'] ) && $params['parent'] instanceof HTMLForm ) {
 361                         $this->mParent = $params['parent'];
 362                 }
 363
 364                 # Generate the label from a message, if possible
 365                 if ( isset( $params['label-message'] ) ) {
 366                         $msgInfo = $params['label-message'];
 367
 368                         if ( is_array( $msgInfo ) ) {
 369                                 $msg = array_shift( $msgInfo );
 370                         } else {
 371                                 $msg = $msgInfo;
 372                                 $msgInfo = array();
 373                         }
 374
 375                         $this->mLabel = $this->msg( $msg, $msgInfo )->parse();
 376                 } elseif ( isset( $params['label'] ) ) {
 377                         if ( $params['label'] === '&#160;' ) {
 378                                 // Apparently some things set &nbsp directly and in an odd format
 379                                 $this->mLabel = '&#160;';
 380                         } else {
 381                                 $this->mLabel = htmlspecialchars( $params['label'] );
 382                         }
 383                 } elseif ( isset( $params['label-raw'] ) ) {
 384                         $this->mLabel = $params['label-raw'];
 385                 }
 386
 387                 $this->mName = "wp{$params['fieldname']}";
 388                 if ( isset( $params['name'] ) ) {
 389                         $this->mName = $params['name'];
 390                 }
 391
 392                 if ( isset( $params['dir'] ) ) {
 393                         $this->mDir = $params['dir'];
 394                 }
 395
 396                 $validName = Sanitizer::escapeId( $this->mName );
 397                 $validName = str_replace( array( '.5B', '.5D' ), array( '[', ']' ), $validName );
 398                 if ( $this->mName != $validName && !isset( $params['nodata'] ) ) {
 399                         throw new MWException( "Invalid name '{$this->mName}' passed to " . __METHOD__ );
 400                 }
 401
 402                 $this->mID = "mw-input-{$this->mName}";
 403
 404                 if ( isset( $params['default'] ) ) {
 405                         $this->mDefault = $params['default'];
 406                 }
 407
 408                 if ( isset( $params['id'] ) ) {
 409                         $id = $params['id'];
 410                         $validId = Sanitizer::escapeId( $id );
 411
 412                         if ( $id != $validId ) {
 413                                 throw new MWException( "Invalid id '$id' passed to " . __METHOD__ );
 414                         }
 415
 416                         $this->mID = $id;
 417                 }
 418
 419                 if ( isset( $params['cssclass'] ) ) {
 420                         $this->mClass = $params['cssclass'];
 421                 }
 422
 423                 if ( isset( $params['csshelpclass'] ) ) {
 424                         $this->mHelpClass = $params['csshelpclass'];
 425                 }
 426
 427                 if ( isset( $params['validation-callback'] ) ) {
 428                         $this->mValidationCallback = $params['validation-callback'];
 429                 }
 430
 431                 if ( isset( $params['filter-callback'] ) ) {
 432                         $this->mFilterCallback = $params['filter-callback'];
 433                 }
 434
 435                 if ( isset( $params['flatlist'] ) ) {
 436                         $this->mClass .= ' mw-htmlform-flatlist';
 437                 }
 438
 439                 if ( isset( $params['hidelabel'] ) ) {
 440                         $this->mShowEmptyLabels = false;
 441                 }
 442
 443                 if ( isset( $params['hide-if'] ) ) {
 444                         $this->mHideIf = $params['hide-if'];
 445                 }
 446         }
 447
 448         /**
 449          * Get the complete table row for the input, including help text,
 450          * labels, and whatever.
 451          *
 452          * @param string $value The value to set the input to.
 453          *
 454          * @return string Complete HTML table row.
 455          */
 456         function getTableRow( $value ) {
 457                 list( $errors, $errorClass ) = $this->getErrorsAndErrorClass( $value );
 458                 $inputHtml = $this->getInputHTML( $value );
 459                 $fieldType = get_class( $this );
 460                 $helptext = $this->getHelpTextHtmlTable( $this->getHelpText() );
 461                 $cellAttributes = array();
 462                 $rowAttributes = array();
 463                 $rowClasses = '';
 464
 465                 if ( !empty( $this->mParams['vertical-label'] ) ) {
 466                         $cellAttributes['colspan'] = 2;
 467                         $verticalLabel = true;
 468                 } else {
 469                         $verticalLabel = false;
 470                 }
 471
 472                 $label = $this->getLabelHtml( $cellAttributes );
 473
 474                 $field = Html::rawElement(
 475                         'td',
 476                         array( 'class' => 'mw-input' ) + $cellAttributes,
 477                         $inputHtml . "\n$errors"
 478                 );
 479
 480                 if ( $this->mHideIf ) {
 481                         $rowAttributes['data-hide-if'] = FormatJson::encode( $this->mHideIf );
 482                         $rowClasses .= ' mw-htmlform-hide-if';
 483                 }
 484
 485                 if ( $verticalLabel ) {
 486                         $html = Html::rawElement( 'tr',
 487                                 $rowAttributes + array( 'class' => "mw-htmlform-vertical-label $rowClasses" ), $label );
 488                         $html .= Html::rawElement( 'tr',
 489                                 $rowAttributes + array(
 490                                         'class' => "mw-htmlform-field-$fieldType {$this->mClass} $errorClass $rowClasses"
 491                                 ),
 492                                 $field );
 493                 } else {
 494                         $html =
 495                                 Html::rawElement( 'tr',
 496                                         $rowAttributes + array(
 497                                                 'class' => "mw-htmlform-field-$fieldType {$this->mClass} $errorClass $rowClasses"
 498                                         ),
 499                                         $label . $field );
 500                 }
 501
 502                 return $html . $helptext;
 503         }
 504
 505         /**
 506          * Get the complete div for the input, including help text,
 507          * labels, and whatever.
 508          * @since 1.20
 509          *
 510          * @param string $value The value to set the input to.
 511          *
 512          * @return string Complete HTML table row.
 513          */
 514         public function getDiv( $value ) {
 515                 list( $errors, $errorClass ) = $this->getErrorsAndErrorClass( $value );
 516                 $inputHtml = $this->getInputHTML( $value );
 517                 $fieldType = get_class( $this );
 518                 $helptext = $this->getHelpTextHtmlDiv( $this->getHelpText() );
 519                 $cellAttributes = array();
 520                 $label = $this->getLabelHtml( $cellAttributes );
 521
 522                 $outerDivClass = array(
 523                         'mw-input',
 524                         'mw-htmlform-nolabel' => ( $label === '' )
 525                 );
 526
 527                 $field = Html::rawElement(
 528                         'div',
 529                         array( 'class' => $outerDivClass ) + $cellAttributes,
 530                         $inputHtml . "\n$errors"
 531                 );
 532                 $divCssClasses = array( "mw-htmlform-field-$fieldType", $this->mClass, $this->mVFormClass, $errorClass );
 533
 534                 $wrapperAttributes = array(
 535                         'class' => $divCssClasses,
 536                 );
 537                 if ( $this->mHideIf ) {
 538                         $wrapperAttributes['data-hide-if'] = FormatJson::encode( $this->mHideIf );
 539                         $wrapperAttributes['class'][] = ' mw-htmlform-hide-if';
 540                 }
 541                 $html = Html::rawElement( 'div', $wrapperAttributes, $label . $field );
 542                 $html .= $helptext;
 543
 544                 return $html;
 545         }
 546
 547         /**
 548          * Get the OOUI version of the div. Falls back to getDiv by default.
 549          * @since 1.26
 550          *
 551          * @param string $value The value to set the input to.
 552          *
 553          * @return string
 554          */
 555         public function getOOUI( $value ) {
 556                 list( $errors, $errorClass ) = $this->getErrorsAndErrorClass( $value );
 557
 558                 $inputField = $this->getInputOOUI( $value );
 559
 560                 if ( !$inputField ) {
 561                         // This field doesn't have an OOUI implementation yet at all.
 562                         // OK, use this trick:
 563                         return $this->getDiv( $value );
 564                 }
 565
 566                 $infusable = true;
 567                 if ( is_string( $inputField ) ) {
 568                         // Mmm… We have an OOUI implementation, but it's not complete, and we got a load of HTML.
 569                         // Cheat a little and wrap it in a widget! It won't be infusable, though, since client-side
 570                         // JavaScript doesn't know how to rebuilt the contents.
 571                         $inputField = new OOUI\Widget( array( 'content' => new OOUI\HtmlSnippet( $inputField ) ) );
 572                         $infusable = false;
 573                 }
 574
 575                 $fieldType = get_class( $this );
 576                 $field = new OOUI\FieldLayout( $inputField, array(
 577                         'classes' => array( "mw-htmlform-field-$fieldType", $this->mClass, $errorClass ),
 578                         'align' => $this->getLabelAlignOOUI(),
 579                         'label' => $this->getLabel(),
 580                         'help' => $this->getHelpText(),
 581                         'infusable' => $infusable,
 582                 ) );
 583
 584                 return $field . $errors;
 585         }
 586
 587         /**
 588          * Get label alignment when generating field for OOUI.
 589          * @return string 'left', 'right', 'top' or 'inline'
 590          */
 591         protected function getLabelAlignOOUI() {
 592                 return 'top';
 593         }
 594
 595         /**
 596          * Get the complete raw fields for the input, including help text,
 597          * labels, and whatever.
 598          * @since 1.20
 599          *
 600          * @param string $value The value to set the input to.
 601          *
 602          * @return string Complete HTML table row.
 603          */
 604         public function getRaw( $value ) {
 605                 list( $errors, ) = $this->getErrorsAndErrorClass( $value );
 606                 $inputHtml = $this->getInputHTML( $value );
 607                 $helptext = $this->getHelpTextHtmlRaw( $this->getHelpText() );
 608                 $cellAttributes = array();
 609                 $label = $this->getLabelHtml( $cellAttributes );
 610
 611                 $html = "\n$errors";
 612                 $html .= $label;
 613                 $html .= $inputHtml;
 614                 $html .= $helptext;
 615
 616                 return $html;
 617         }
 618
 619         /**
 620          * Get the complete field for the input, including help text,
 621          * labels, and whatever. Fall back from 'vform' to 'div' when not overridden.
 622          *
 623          * @since 1.25
 624          * @param string $value The value to set the input to.
 625          * @return string Complete HTML field.
 626          */
 627         public function getVForm( $value ) {
 628                 // Ewwww
 629                 $this->mVFormClass = ' mw-ui-vform-field';
 630                 return $this->getDiv( $value );
 631         }
 632
 633         /**
 634          * Get the complete field as an inline element.
 635          * @since 1.25
 636          * @param string $value The value to set the input to.
 637          * @return string Complete HTML inline element
 638          */
 639         public function getInline( $value ) {
 640                 list( $errors, $errorClass ) = $this->getErrorsAndErrorClass( $value );
 641                 $inputHtml = $this->getInputHTML( $value );
 642                 $helptext = $this->getHelpTextHtmlDiv( $this->getHelpText() );
 643                 $cellAttributes = array();
 644                 $label = $this->getLabelHtml( $cellAttributes );
 645
 646                 $html = "\n" . $errors .
 647                         $label . '&#160;' .
 648                         $inputHtml .
 649                         $helptext;
 650
 651                 return $html;
 652         }
 653
 654         /**
 655          * Generate help text HTML in table format
 656          * @since 1.20
 657          *
 658          * @param string|null $helptext
 659          * @return string
 660          */
 661         public function getHelpTextHtmlTable( $helptext ) {
 662                 if ( is_null( $helptext ) ) {
 663                         return '';
 664                 }
 665
 666                 $rowAttributes = array();
 667                 if ( $this->mHideIf ) {
 668                         $rowAttributes['data-hide-if'] = FormatJson::encode( $this->mHideIf );
 669                         $rowAttributes['class'] = 'mw-htmlform-hide-if';
 670                 }
 671
 672                 $tdClasses = array( 'htmlform-tip' );
 673                 if ( $this->mHelpClass !== false ) {
 674                         $tdClasses[] = $this->mHelpClass;
 675                 }
 676                 $row = Html::rawElement( 'td', array( 'colspan' => 2, 'class' => $tdClasses ), $helptext );
 677                 $row = Html::rawElement( 'tr', $rowAttributes, $row );
 678
 679                 return $row;
 680         }
 681
 682         /**
 683          * Generate help text HTML in div format
 684          * @since 1.20
 685          *
 686          * @param string|null $helptext
 687          *
 688          * @return string
 689          */
 690         public function getHelpTextHtmlDiv( $helptext ) {
 691                 if ( is_null( $helptext ) ) {
 692                         return '';
 693                 }
 694
 695                 $wrapperAttributes = array(
 696                         'class' => 'htmlform-tip',
 697                 );
 698                 if ( $this->mHelpClass !== false ) {
 699                         $wrapperAttributes['class'] .= " {$this->mHelpClass}";
 700                 }
 701                 if ( $this->mHideIf ) {
 702                         $wrapperAttributes['data-hide-if'] = FormatJson::encode( $this->mHideIf );
 703                         $wrapperAttributes['class'] .= ' mw-htmlform-hide-if';
 704                 }
 705                 $div = Html::rawElement( 'div', $wrapperAttributes, $helptext );
 706
 707                 return $div;
 708         }
 709
 710         /**
 711          * Generate help text HTML formatted for raw output
 712          * @since 1.20
 713          *
 714          * @param string|null $helptext
 715          * @return string
 716          */
 717         public function getHelpTextHtmlRaw( $helptext ) {
 718                 return $this->getHelpTextHtmlDiv( $helptext );
 719         }
 720
 721         /**
 722          * Determine the help text to display
 723          * @since 1.20
 724          * @return string
 725          */
 726         public function getHelpText() {
 727                 $helptext = null;
 728
 729                 if ( isset( $this->mParams['help-message'] ) ) {
 730                         $this->mParams['help-messages'] = array( $this->mParams['help-message'] );
 731                 }
 732
 733                 if ( isset( $this->mParams['help-messages'] ) ) {
 734                         foreach ( $this->mParams['help-messages'] as $name ) {
 735                                 $helpMessage = (array)$name;
 736                                 $msg = $this->msg( array_shift( $helpMessage ), $helpMessage );
 737
 738                                 if ( $msg->exists() ) {
 739                                         if ( is_null( $helptext ) ) {
 740                                                 $helptext = '';
 741                                         } else {
 742                                                 $helptext .= $this->msg( 'word-separator' )->escaped(); // some space
 743                                         }
 744                                         $helptext .= $msg->parse(); // Append message
 745                                 }
 746                         }
 747                 } elseif ( isset( $this->mParams['help'] ) ) {
 748                         $helptext = $this->mParams['help'];
 749                 }
 750
 751                 return $helptext;
 752         }
 753
 754         /**
 755          * Determine form errors to display and their classes
 756          * @since 1.20
 757          *
 758          * @param string $value The value of the input
 759          * @return array
 760          */
 761         public function getErrorsAndErrorClass( $value ) {
 762                 $errors = $this->validate( $value, $this->mParent->mFieldData );
 763
 764                 if ( is_bool( $errors ) || !$this->mParent->wasSubmitted() ) {
 765                         $errors = '';
 766                         $errorClass = '';
 767                 } else {
 768                         $errors = self::formatErrors( $errors );
 769                         $errorClass = 'mw-htmlform-invalid-input';
 770                 }
 771
 772                 return array( $errors, $errorClass );
 773         }
 774
 775         /**
 776          * @return string
 777          */
 778         function getLabel() {
 779                 return is_null( $this->mLabel ) ? '' : $this->mLabel;
 780         }
 781
 782         function getLabelHtml( $cellAttributes = array() ) {
 783                 # Don't output a for= attribute for labels with no associated input.
 784                 # Kind of hacky here, possibly we don't want these to be <label>s at all.
 785                 $for = array();
 786
 787                 if ( $this->needsLabel() ) {
 788                         $for['for'] = $this->mID;
 789                 }
 790
 791                 $labelValue = trim( $this->getLabel() );
 792                 $hasLabel = false;
 793                 if ( $labelValue !== '&#160;' && $labelValue !== '' ) {
 794                         $hasLabel = true;
 795                 }
 796
 797                 $displayFormat = $this->mParent->getDisplayFormat();
 798                 $html = '';
 799
 800                 if ( $displayFormat === 'table' ) {
 801                         $html =
 802                                 Html::rawElement( 'td',
 803                                         array( 'class' => 'mw-label' ) + $cellAttributes,
 804                                         Html::rawElement( 'label', $for, $labelValue ) );
 805                 } elseif ( $hasLabel || $this->mShowEmptyLabels ) {
 806                         if ( $displayFormat === 'div' ) {
 807                                 $html =
 808                                         Html::rawElement( 'div',
 809                                                 array( 'class' => 'mw-label' ) + $cellAttributes,
 810                                                 Html::rawElement( 'label', $for, $labelValue ) );
 811                         } else {
 812                                 $html = Html::rawElement( 'label', $for, $labelValue );
 813                         }
 814                 }
 815
 816                 return $html;
 817         }
 818
 819         function getDefault() {
 820                 if ( isset( $this->mDefault ) ) {
 821                         return $this->mDefault;
 822                 } else {
 823                         return null;
 824                 }
 825         }
 826
 827         /**
 828          * Returns the attributes required for the tooltip and accesskey.
 829          *
 830          * @return array Attributes
 831          */
 832         public function getTooltipAndAccessKey() {
 833                 if ( empty( $this->mParams['tooltip'] ) ) {
 834                         return array();
 835                 }
 836
 837                 return Linker::tooltipAndAccesskeyAttribs( $this->mParams['tooltip'] );
 838         }
 839
 840         /**
 841          * Get a translated key if necessary.
 842          * @param array|null $mappings Array of mappings, 'original' => 'translated'
 843          * @param string $key
 844          * @return string
 845          */
 846         protected function getMappedKey( $mappings, $key ) {
 847                 if ( !is_array( $mappings ) ) {
 848                         return $key;
 849                 }
 850
 851                 if ( !empty( $mappings[$key] ) ) {
 852                         return $mappings[$key];
 853                 }
 854
 855                 return $key;
 856         }
 857
 858         /**
 859          * Returns the given attributes from the parameters
 860          *
 861          * @param array $list List of attributes to get
 862          * @param array $mappings Optional - Key/value map of attribute names to use instead of the ones passed in
 863          * @return array Attributes
 864          */
 865         public function getAttributes( array $list, array $mappings = null ) {
 866                 static $boolAttribs = array( 'disabled', 'required', 'autofocus', 'multiple', 'readonly' );
 867
 868                 $ret = array();
 869                 foreach ( $list as $key ) {
 870                         $mappedKey = $this->getMappedKey( $mappings, $key );
 871
 872                         if ( in_array( $key, $boolAttribs ) ) {
 873                                 if ( !empty( $this->mParams[$key] ) ) {
 874                                         $ret[$mappedKey] = '';
 875                                 }
 876                         } elseif ( isset( $this->mParams[$key] ) ) {
 877                                 $ret[$mappedKey] = $this->mParams[$key];
 878                         }
 879                 }
 880
 881                 return $ret;
 882         }
 883
 884         /**
 885          * Given an array of msg-key => value mappings, returns an array with keys
 886          * being the message texts. It also forces values to strings.
 887          *
 888          * @param array $options
 889          * @return array
 890          */
 891         private function lookupOptionsKeys( $options ) {
 892                 $ret = array();
 893                 foreach ( $options as $key => $value ) {
 894                         $key = $this->msg( $key )->plain();
 895                         $ret[$key] = is_array( $value )
 896                                 ? $this->lookupOptionsKeys( $value )
 897                                 : strval( $value );
 898                 }
 899                 return $ret;
 900         }
 901
 902         /**
 903          * Recursively forces values in an array to strings, because issues arise
 904          * with integer 0 as a value.
 905          *
 906          * @param array $array
 907          * @return array
 908          */
 909         static function forceToStringRecursive( $array ) {
 910                 if ( is_array( $array ) ) {
 911                         return array_map( array( __CLASS__, 'forceToStringRecursive' ), $array );
 912                 } else {
 913                         return strval( $array );
 914                 }
 915         }
 916
 917         /**
 918          * Fetch the array of options from the field's parameters. In order, this
 919          * checks 'options-messages', 'options', then 'options-message'.
 920          *
 921          * @return array|null Options array
 922          */
 923         public function getOptions() {
 924                 if ( $this->mOptions === false ) {
 925                         if ( array_key_exists( 'options-messages', $this->mParams ) ) {
 926                                 $this->mOptions = $this->lookupOptionsKeys( $this->mParams['options-messages'] );
 927                         } elseif ( array_key_exists( 'options', $this->mParams ) ) {
 928                                 $this->mOptionsLabelsNotFromMessage = true;
 929                                 $this->mOptions = self::forceToStringRecursive( $this->mParams['options'] );
 930                         } elseif ( array_key_exists( 'options-message', $this->mParams ) ) {
 931                                 /** @todo This is copied from Xml::listDropDown(), deprecate/avoid duplication? */
 932                                 $message = $this->msg( $this->mParams['options-message'] )->inContentLanguage()->plain();
 933
 934                                 $optgroup = false;
 935                                 $this->mOptions = array();
 936                                 foreach ( explode( "\n", $message ) as $option ) {
 937                                         $value = trim( $option );
 938                                         if ( $value == '' ) {
 939                                                 continue;
 940                                         } elseif ( substr( $value, 0, 1 ) == '*' && substr( $value, 1, 1 ) != '*' ) {
 941                                                 # A new group is starting...
 942                                                 $value = trim( substr( $value, 1 ) );
 943                                                 $optgroup = $value;
 944                                         } elseif ( substr( $value, 0, 2 ) == '**' ) {
 945                                                 # groupmember
 946                                                 $opt = trim( substr( $value, 2 ) );
 947                                                 if ( $optgroup === false ) {
 948                                                         $this->mOptions[$opt] = $opt;
 949                                                 } else {
 950                                                         $this->mOptions[$optgroup][$opt] = $opt;
 951                                                 }
 952                                         } else {
 953                                                 # groupless reason list
 954                                                 $optgroup = false;
 955                                                 $this->mOptions[$option] = $option;
 956                                         }
 957                                 }
 958                         } else {
 959                                 $this->mOptions = null;
 960                         }
 961                 }
 962
 963                 return $this->mOptions;
 964         }
 965
 966         /**
 967          * Get options and make them into arrays suitable for OOUI.
 968          * @return array Options for inclusion in a select or whatever.
 969          */
 970         public function getOptionsOOUI() {
 971                 $oldoptions = $this->getOptions();
 972
 973                 if ( $oldoptions === null ) {
 974                         return null;
 975                 }
 976
 977                 $options = array();
 978
 979                 foreach ( $oldoptions as $text => $data ) {
 980                         $options[] = array(
 981                                 'data' => $data,
 982                                 'label' => $text,
 983                         );
 984                 }
 985
 986                 return $options;
 987         }
 988
 989         /**
 990          * flatten an array of options to a single array, for instance,
 991          * a set of "<options>" inside "<optgroups>".
 992          *
 993          * @param array $options Associative Array with values either Strings or Arrays
 994          * @return array Flattened input
 995          */
 996         public static function flattenOptions( $options ) {
 997                 $flatOpts = array();
 998
 999                 foreach ( $options as $value ) {
1000                         if ( is_array( $value ) ) {
1001                                 $flatOpts = array_merge( $flatOpts, self::flattenOptions( $value ) );
1002                         } else {
1003                                 $flatOpts[] = $value;
1004                         }
1005                 }
1006
1007                 return $flatOpts;
1008         }
1009
1010         /**
1011          * Formats one or more errors as accepted by field validation-callback.
1012          *
1013          * @param string|Message|array $errors Array of strings or Message instances
1014          * @return string HTML
1015          * @since 1.18
1016          */
1017         protected static function formatErrors( $errors ) {
1018                 if ( is_array( $errors ) && count( $errors ) === 1 ) {
1019                         $errors = array_shift( $errors );
1020                 }
1021
1022                 if ( is_array( $errors ) ) {
1023                         $lines = array();
1024                         foreach ( $errors as $error ) {
1025                                 if ( $error instanceof Message ) {
1026                                         $lines[] = Html::rawElement( 'li', array(), $error->parse() );
1027                                 } else {
1028                                         $lines[] = Html::rawElement( 'li', array(), $error );
1029                                 }
1030                         }
1031
1032                         return Html::rawElement( 'ul', array( 'class' => 'error' ), implode( "\n", $lines ) );
1033                 } else {
1034                         if ( $errors instanceof Message ) {
1035                                 $errors = $errors->parse();
1036                         }
1037
1038                         return Html::rawElement( 'span', array( 'class' => 'error' ), $errors );
1039                 }
1040         }
1041 }