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                 $horizontalLabel = isset( $this->mParams['horizontal-label'] )
 528                         ? $this->mParams['horizontal-label'] : false;
 529
 530                 if ( $horizontalLabel ) {
 531                         $field = '&#160;' . $inputHtml . "\n$errors";
 532                 } else {
 533                         $field = Html::rawElement(
 534                                 'div',
 535                                 array( 'class' => $outerDivClass ) + $cellAttributes,
 536                                 $inputHtml . "\n$errors"
 537                         );
 538                 }
 539                 $divCssClasses = array( "mw-htmlform-field-$fieldType",
 540                         $this->mClass, $this->mVFormClass, $errorClass );
 541
 542                 $wrapperAttributes = array(
 543                         'class' => $divCssClasses,
 544                 );
 545                 if ( $this->mHideIf ) {
 546                         $wrapperAttributes['data-hide-if'] = FormatJson::encode( $this->mHideIf );
 547                         $wrapperAttributes['class'][] = ' mw-htmlform-hide-if';
 548                 }
 549                 $html = Html::rawElement( 'div', $wrapperAttributes, $label . $field );
 550                 $html .= $helptext;
 551
 552                 return $html;
 553         }
 554
 555         /**
 556          * Get the OOUI version of the div. Falls back to getDiv by default.
 557          * @since 1.26
 558          *
 559          * @param string $value The value to set the input to.
 560          *
 561          * @return OOUI\\FieldLayout|OOUI\\ActionFieldLayout
 562          */
 563         public function getOOUI( $value ) {
 564                 $inputField = $this->getInputOOUI( $value );
 565
 566                 if ( !$inputField ) {
 567                         // This field doesn't have an OOUI implementation yet at all. Fall back to getDiv() to
 568                         // generate the whole field, label and errors and all, then wrap it in a Widget.
 569                         // It might look weird, but it'll work OK.
 570                         return $this->getFieldLayoutOOUI(
 571                                 new OOUI\Widget( array( 'content' => new OOUI\HtmlSnippet( $this->getDiv( $value ) ) ) ),
 572                                 array( 'infusable' => false )
 573                         );
 574                 }
 575
 576                 $infusable = true;
 577                 if ( is_string( $inputField ) ) {
 578                         // We have an OOUI implementation, but it's not proper, and we got a load of HTML.
 579                         // Cheat a little and wrap it in a widget. It won't be infusable, though, since client-side
 580                         // JavaScript doesn't know how to rebuilt the contents.
 581                         $inputField = new OOUI\Widget( array( 'content' => new OOUI\HtmlSnippet( $inputField ) ) );
 582                         $infusable = false;
 583                 }
 584
 585                 $fieldType = get_class( $this );
 586                 $helpText = $this->getHelpText();
 587                 $errors = $this->getErrorsRaw( $value );
 588                 foreach ( $errors as &$error ) {
 589                         $error = new OOUI\HtmlSnippet( $error );
 590                 }
 591
 592                 $config = array(
 593                         'classes' => array( "mw-htmlform-field-$fieldType", $this->mClass ),
 594                         'align' => $this->getLabelAlignOOUI(),
 595                         'label' => $this->getLabel(),
 596                         'help' => $helpText !== null ? new OOUI\HtmlSnippet( $helpText ) : null,
 597                         'errors' => $errors,
 598                         'infusable' => $infusable,
 599                 );
 600
 601                 return $this->getFieldLayoutOOUI( $inputField, $config );
 602         }
 603
 604         /**
 605          * Get label alignment when generating field for OOUI.
 606          * @return string 'left', 'right', 'top' or 'inline'
 607          */
 608         protected function getLabelAlignOOUI() {
 609                 return 'top';
 610         }
 611
 612         /**
 613          * Get a FieldLayout (or subclass thereof) to wrap this field in when using OOUI output.
 614          * @return OOUI\\FieldLayout|OOUI\\ActionFieldLayout
 615          */
 616         protected function getFieldLayoutOOUI( $inputField, $config ) {
 617                 if ( isset( $this->mClassWithButton ) ) {
 618                         $buttonWidget = $this->mClassWithButton->getInputOOUI( '' );
 619                         return new OOUI\ActionFieldLayout( $inputField, $buttonWidget, $config );
 620                 }
 621                 return new OOUI\FieldLayout( $inputField, $config );
 622         }
 623
 624         /**
 625          * Get the complete raw fields for the input, including help text,
 626          * labels, and whatever.
 627          * @since 1.20
 628          *
 629          * @param string $value The value to set the input to.
 630          *
 631          * @return string Complete HTML table row.
 632          */
 633         public function getRaw( $value ) {
 634                 list( $errors, ) = $this->getErrorsAndErrorClass( $value );
 635                 $inputHtml = $this->getInputHTML( $value );
 636                 $helptext = $this->getHelpTextHtmlRaw( $this->getHelpText() );
 637                 $cellAttributes = array();
 638                 $label = $this->getLabelHtml( $cellAttributes );
 639
 640                 $html = "\n$errors";
 641                 $html .= $label;
 642                 $html .= $inputHtml;
 643                 $html .= $helptext;
 644
 645                 return $html;
 646         }
 647
 648         /**
 649          * Get the complete field for the input, including help text,
 650          * labels, and whatever. Fall back from 'vform' to 'div' when not overridden.
 651          *
 652          * @since 1.25
 653          * @param string $value The value to set the input to.
 654          * @return string Complete HTML field.
 655          */
 656         public function getVForm( $value ) {
 657                 // Ewwww
 658                 $this->mVFormClass = ' mw-ui-vform-field';
 659                 return $this->getDiv( $value );
 660         }
 661
 662         /**
 663          * Get the complete field as an inline element.
 664          * @since 1.25
 665          * @param string $value The value to set the input to.
 666          * @return string Complete HTML inline element
 667          */
 668         public function getInline( $value ) {
 669                 list( $errors, $errorClass ) = $this->getErrorsAndErrorClass( $value );
 670                 $inputHtml = $this->getInputHTML( $value );
 671                 $helptext = $this->getHelpTextHtmlDiv( $this->getHelpText() );
 672                 $cellAttributes = array();
 673                 $label = $this->getLabelHtml( $cellAttributes );
 674
 675                 $html = "\n" . $errors .
 676                         $label . '&#160;' .
 677                         $inputHtml .
 678                         $helptext;
 679
 680                 return $html;
 681         }
 682
 683         /**
 684          * Generate help text HTML in table format
 685          * @since 1.20
 686          *
 687          * @param string|null $helptext
 688          * @return string
 689          */
 690         public function getHelpTextHtmlTable( $helptext ) {
 691                 if ( is_null( $helptext ) ) {
 692                         return '';
 693                 }
 694
 695                 $rowAttributes = array();
 696                 if ( $this->mHideIf ) {
 697                         $rowAttributes['data-hide-if'] = FormatJson::encode( $this->mHideIf );
 698                         $rowAttributes['class'] = 'mw-htmlform-hide-if';
 699                 }
 700
 701                 $tdClasses = array( 'htmlform-tip' );
 702                 if ( $this->mHelpClass !== false ) {
 703                         $tdClasses[] = $this->mHelpClass;
 704                 }
 705                 $row = Html::rawElement( 'td', array( 'colspan' => 2, 'class' => $tdClasses ), $helptext );
 706                 $row = Html::rawElement( 'tr', $rowAttributes, $row );
 707
 708                 return $row;
 709         }
 710
 711         /**
 712          * Generate help text HTML in div format
 713          * @since 1.20
 714          *
 715          * @param string|null $helptext
 716          *
 717          * @return string
 718          */
 719         public function getHelpTextHtmlDiv( $helptext ) {
 720                 if ( is_null( $helptext ) ) {
 721                         return '';
 722                 }
 723
 724                 $wrapperAttributes = array(
 725                         'class' => 'htmlform-tip',
 726                 );
 727                 if ( $this->mHelpClass !== false ) {
 728                         $wrapperAttributes['class'] .= " {$this->mHelpClass}";
 729                 }
 730                 if ( $this->mHideIf ) {
 731                         $wrapperAttributes['data-hide-if'] = FormatJson::encode( $this->mHideIf );
 732                         $wrapperAttributes['class'] .= ' mw-htmlform-hide-if';
 733                 }
 734                 $div = Html::rawElement( 'div', $wrapperAttributes, $helptext );
 735
 736                 return $div;
 737         }
 738
 739         /**
 740          * Generate help text HTML formatted for raw output
 741          * @since 1.20
 742          *
 743          * @param string|null $helptext
 744          * @return string
 745          */
 746         public function getHelpTextHtmlRaw( $helptext ) {
 747                 return $this->getHelpTextHtmlDiv( $helptext );
 748         }
 749
 750         /**
 751          * Determine the help text to display
 752          * @since 1.20
 753          * @return string HTML
 754          */
 755         public function getHelpText() {
 756                 $helptext = null;
 757
 758                 if ( isset( $this->mParams['help-message'] ) ) {
 759                         $this->mParams['help-messages'] = array( $this->mParams['help-message'] );
 760                 }
 761
 762                 if ( isset( $this->mParams['help-messages'] ) ) {
 763                         foreach ( $this->mParams['help-messages'] as $name ) {
 764                                 $helpMessage = (array)$name;
 765                                 $msg = $this->msg( array_shift( $helpMessage ), $helpMessage );
 766
 767                                 if ( $msg->exists() ) {
 768                                         if ( is_null( $helptext ) ) {
 769                                                 $helptext = '';
 770                                         } else {
 771                                                 $helptext .= $this->msg( 'word-separator' )->escaped(); // some space
 772                                         }
 773                                         $helptext .= $msg->parse(); // Append message
 774                                 }
 775                         }
 776                 } elseif ( isset( $this->mParams['help'] ) ) {
 777                         $helptext = $this->mParams['help'];
 778                 }
 779
 780                 return $helptext;
 781         }
 782
 783         /**
 784          * Determine form errors to display and their classes
 785          * @since 1.20
 786          *
 787          * @param string $value The value of the input
 788          * @return array array( $errors, $errorClass )
 789          */
 790         public function getErrorsAndErrorClass( $value ) {
 791                 $errors = $this->validate( $value, $this->mParent->mFieldData );
 792
 793                 if ( is_bool( $errors ) || !$this->mParent->wasSubmitted() ) {
 794                         $errors = '';
 795                         $errorClass = '';
 796                 } else {
 797                         $errors = self::formatErrors( $errors );
 798                         $errorClass = 'mw-htmlform-invalid-input';
 799                 }
 800
 801                 return array( $errors, $errorClass );
 802         }
 803
 804         /**
 805          * Determine form errors to display, returning them in an array.
 806          *
 807          * @since 1.26
 808          * @param string $value The value of the input
 809          * @return string[] Array of error HTML strings
 810          */
 811         public function getErrorsRaw( $value ) {
 812                 $errors = $this->validate( $value, $this->mParent->mFieldData );
 813
 814                 if ( is_bool( $errors ) || !$this->mParent->wasSubmitted() ) {
 815                         $errors = array();
 816                 }
 817
 818                 if ( !is_array( $errors ) ) {
 819                         $errors = array( $errors );
 820                 }
 821                 foreach ( $errors as &$error ) {
 822                         if ( $error instanceof Message ) {
 823                                 $error = $error->parse();
 824                         }
 825                 }
 826
 827                 return $errors;
 828         }
 829
 830         /**
 831          * @return string
 832          */
 833         function getLabel() {
 834                 return is_null( $this->mLabel ) ? '' : $this->mLabel;
 835         }
 836
 837         function getLabelHtml( $cellAttributes = array() ) {
 838                 # Don't output a for= attribute for labels with no associated input.
 839                 # Kind of hacky here, possibly we don't want these to be <label>s at all.
 840                 $for = array();
 841
 842                 if ( $this->needsLabel() ) {
 843                         $for['for'] = $this->mID;
 844                 }
 845
 846                 $labelValue = trim( $this->getLabel() );
 847                 $hasLabel = false;
 848                 if ( $labelValue !== '&#160;' && $labelValue !== '' ) {
 849                         $hasLabel = true;
 850                 }
 851
 852                 $displayFormat = $this->mParent->getDisplayFormat();
 853                 $html = '';
 854                 $horizontalLabel = isset( $this->mParams['horizontal-label'] )
 855                         ? $this->mParams['horizontal-label'] : false;
 856
 857                 if ( $displayFormat === 'table' ) {
 858                         $html =
 859                                 Html::rawElement( 'td',
 860                                         array( 'class' => 'mw-label' ) + $cellAttributes,
 861                                         Html::rawElement( 'label', $for, $labelValue ) );
 862                 } elseif ( $hasLabel || $this->mShowEmptyLabels ) {
 863                         if ( $displayFormat === 'div' && !$horizontalLabel ) {
 864                                 $html =
 865                                         Html::rawElement( 'div',
 866                                                 array( 'class' => 'mw-label' ) + $cellAttributes,
 867                                                 Html::rawElement( 'label', $for, $labelValue ) );
 868                         } else {
 869                                 $html = Html::rawElement( 'label', $for, $labelValue );
 870                         }
 871                 }
 872
 873                 return $html;
 874         }
 875
 876         function getDefault() {
 877                 if ( isset( $this->mDefault ) ) {
 878                         return $this->mDefault;
 879                 } else {
 880                         return null;
 881                 }
 882         }
 883
 884         /**
 885          * Returns the attributes required for the tooltip and accesskey.
 886          *
 887          * @return array Attributes
 888          */
 889         public function getTooltipAndAccessKey() {
 890                 if ( empty( $this->mParams['tooltip'] ) ) {
 891                         return array();
 892                 }
 893
 894                 return Linker::tooltipAndAccesskeyAttribs( $this->mParams['tooltip'] );
 895         }
 896
 897         /**
 898          * Get a translated key if necessary.
 899          * @param array|null $mappings Array of mappings, 'original' => 'translated'
 900          * @param string $key
 901          * @return string
 902          */
 903         protected function getMappedKey( $mappings, $key ) {
 904                 if ( !is_array( $mappings ) ) {
 905                         return $key;
 906                 }
 907
 908                 if ( !empty( $mappings[$key] ) ) {
 909                         return $mappings[$key];
 910                 }
 911
 912                 return $key;
 913         }
 914
 915         /**
 916          * Returns the given attributes from the parameters
 917          *
 918          * @param array $list List of attributes to get
 919          * @param array $mappings Optional - Key/value map of attribute names to use instead of the ones passed in
 920          * @return array Attributes
 921          */
 922         public function getAttributes( array $list, array $mappings = null ) {
 923                 static $boolAttribs = array( 'disabled', 'required', 'autofocus', 'multiple', 'readonly' );
 924
 925                 $ret = array();
 926                 foreach ( $list as $key ) {
 927                         $mappedKey = $this->getMappedKey( $mappings, $key );
 928
 929                         if ( in_array( $key, $boolAttribs ) ) {
 930                                 if ( !empty( $this->mParams[$key] ) ) {
 931                                         $ret[$mappedKey] = $mappedKey;
 932                                 }
 933                         } elseif ( isset( $this->mParams[$key] ) ) {
 934                                 $ret[$mappedKey] = $this->mParams[$key];
 935                         }
 936                 }
 937
 938                 return $ret;
 939         }
 940
 941         /**
 942          * Given an array of msg-key => value mappings, returns an array with keys
 943          * being the message texts. It also forces values to strings.
 944          *
 945          * @param array $options
 946          * @return array
 947          */
 948         private function lookupOptionsKeys( $options ) {
 949                 $ret = array();
 950                 foreach ( $options as $key => $value ) {
 951                         $key = $this->msg( $key )->plain();
 952                         $ret[$key] = is_array( $value )
 953                                 ? $this->lookupOptionsKeys( $value )
 954                                 : strval( $value );
 955                 }
 956                 return $ret;
 957         }
 958
 959         /**
 960          * Recursively forces values in an array to strings, because issues arise
 961          * with integer 0 as a value.
 962          *
 963          * @param array $array
 964          * @return array
 965          */
 966         static function forceToStringRecursive( $array ) {
 967                 if ( is_array( $array ) ) {
 968                         return array_map( array( __CLASS__, 'forceToStringRecursive' ), $array );
 969                 } else {
 970                         return strval( $array );
 971                 }
 972         }
 973
 974         /**
 975          * Fetch the array of options from the field's parameters. In order, this
 976          * checks 'options-messages', 'options', then 'options-message'.
 977          *
 978          * @return array|null Options array
 979          */
 980         public function getOptions() {
 981                 if ( $this->mOptions === false ) {
 982                         if ( array_key_exists( 'options-messages', $this->mParams ) ) {
 983                                 $this->mOptions = $this->lookupOptionsKeys( $this->mParams['options-messages'] );
 984                         } elseif ( array_key_exists( 'options', $this->mParams ) ) {
 985                                 $this->mOptionsLabelsNotFromMessage = true;
 986                                 $this->mOptions = self::forceToStringRecursive( $this->mParams['options'] );
 987                         } elseif ( array_key_exists( 'options-message', $this->mParams ) ) {
 988                                 /** @todo This is copied from Xml::listDropDown(), deprecate/avoid duplication? */
 989                                 $message = $this->msg( $this->mParams['options-message'] )->inContentLanguage()->plain();
 990
 991                                 $optgroup = false;
 992                                 $this->mOptions = array();
 993                                 foreach ( explode( "\n", $message ) as $option ) {
 994                                         $value = trim( $option );
 995                                         if ( $value == '' ) {
 996                                                 continue;
 997                                         } elseif ( substr( $value, 0, 1 ) == '*' && substr( $value, 1, 1 ) != '*' ) {
 998                                                 # A new group is starting...
 999                                                 $value = trim( substr( $value, 1 ) );
1000                                                 $optgroup = $value;
1001                                         } elseif ( substr( $value, 0, 2 ) == '**' ) {
1002                                                 # groupmember
1003                                                 $opt = trim( substr( $value, 2 ) );
1004                                                 if ( $optgroup === false ) {
1005                                                         $this->mOptions[$opt] = $opt;
1006                                                 } else {
1007                                                         $this->mOptions[$optgroup][$opt] = $opt;
1008                                                 }
1009                                         } else {
1010                                                 # groupless reason list
1011                                                 $optgroup = false;
1012                                                 $this->mOptions[$option] = $option;
1013                                         }
1014                                 }
1015                         } else {
1016                                 $this->mOptions = null;
1017                         }
1018                 }
1019
1020                 return $this->mOptions;
1021         }
1022
1023         /**
1024          * Get options and make them into arrays suitable for OOUI.
1025          * @return array Options for inclusion in a select or whatever.
1026          */
1027         public function getOptionsOOUI() {
1028                 $oldoptions = $this->getOptions();
1029
1030                 if ( $oldoptions === null ) {
1031                         return null;
1032                 }
1033
1034                 $options = array();
1035
1036                 foreach ( $oldoptions as $text => $data ) {
1037                         $options[] = array(
1038                                 'data' => $data,
1039                                 'label' => $text,
1040                         );
1041                 }
1042
1043                 return $options;
1044         }
1045
1046         /**
1047          * flatten an array of options to a single array, for instance,
1048          * a set of "<options>" inside "<optgroups>".
1049          *
1050          * @param array $options Associative Array with values either Strings or Arrays
1051          * @return array Flattened input
1052          */
1053         public static function flattenOptions( $options ) {
1054                 $flatOpts = array();
1055
1056                 foreach ( $options as $value ) {
1057                         if ( is_array( $value ) ) {
1058                                 $flatOpts = array_merge( $flatOpts, self::flattenOptions( $value ) );
1059                         } else {
1060                                 $flatOpts[] = $value;
1061                         }
1062                 }
1063
1064                 return $flatOpts;
1065         }
1066
1067         /**
1068          * Formats one or more errors as accepted by field validation-callback.
1069          *
1070          * @param string|Message|array $errors Array of strings or Message instances
1071          * @return string HTML
1072          * @since 1.18
1073          */
1074         protected static function formatErrors( $errors ) {
1075                 if ( is_array( $errors ) && count( $errors ) === 1 ) {
1076                         $errors = array_shift( $errors );
1077                 }
1078
1079                 if ( is_array( $errors ) ) {
1080                         $lines = array();
1081                         foreach ( $errors as $error ) {
1082                                 if ( $error instanceof Message ) {
1083                                         $lines[] = Html::rawElement( 'li', array(), $error->parse() );
1084                                 } else {
1085                                         $lines[] = Html::rawElement( 'li', array(), $error );
1086                                 }
1087                         }
1088
1089                         return Html::rawElement( 'ul', array( 'class' => 'error' ), implode( "\n", $lines ) );
1090                 } else {
1091                         if ( $errors instanceof Message ) {
1092                                 $errors = $errors->parse();
1093                         }
1094
1095                         return Html::rawElement( 'span', array( 'class' => 'error' ), $errors );
1096                 }
1097         }
1098 }