4 * The parent class to generate form fields. Any field type should
5 * be a subclass of this.
7 abstract class HTMLFormField
{
10 protected $mValidationCallback;
11 protected $mFilterCallback;
14 protected $mLabel; # String label, as HTML. Set on construction.
16 protected $mClass = '';
17 protected $mVFormClass = '';
18 protected $mHelpClass = false;
21 * @var array|bool|null
23 protected $mOptions = false;
24 protected $mOptionsLabelsNotFromMessage = false;
25 protected $mHideIf = null;
28 * @var bool If true will generate an empty div element with no label
31 protected $mShowEmptyLabels = true;
39 * This function must be implemented to return the HTML to generate
40 * the input object itself. It should not implement the surrounding
41 * table cells/rows, or labels/help messages.
43 * @param string $value The value to set the input to; eg a default
44 * text for a text input.
46 * @return string Valid HTML.
48 abstract public function getInputHTML( $value );
51 * Same as getInputHTML, but returns an OOUI object.
52 * Defaults to false, which getOOUI will interpret as "use the HTML version"
54 * @param string $value
55 * @return OOUI\Widget|false
57 public function getInputOOUI( $value ) {
62 * True if this field type is able to display errors; false if validation errors need to be
63 * displayed in the main HTMLForm error area.
66 public function canDisplayErrors() {
67 return $this->hasVisibleOutput();
71 * Get a translated interface message
73 * This is a wrapper around $this->mParent->msg() if $this->mParent is set
74 * and wfMessage() otherwise.
76 * Parameters are the same as wfMessage().
80 public function msg() {
81 $args = func_get_args();
83 if ( $this->mParent
) {
84 return $this->mParent
->msg( ...$args );
86 return wfMessage( ...$args );
90 * If this field has a user-visible output or not. If not,
91 * it will not be rendered
95 public function hasVisibleOutput() {
100 * Fetch a field value from $alldata for the closest field matching a given
103 * This is complex because it needs to handle array fields like the user
104 * would expect. The general algorithm is to look for $name as a sibling
105 * of $this, then a sibling of $this's parent, and so on. Keeping in mind
106 * that $name itself might be referencing an array.
108 * @param array $alldata
109 * @param string $name
112 protected function getNearestFieldByName( $alldata, $name ) {
115 while ( preg_match( '/^(.+)\[([^\]]+)\]$/', $tmp, $m ) ) {
116 array_unshift( $thisKeys, $m[2] );
119 if ( substr( $tmp, 0, 2 ) == 'wp' &&
120 !array_key_exists( $tmp, $alldata ) &&
121 array_key_exists( substr( $tmp, 2 ), $alldata )
123 // Adjust for name mangling.
124 $tmp = substr( $tmp, 2 );
126 array_unshift( $thisKeys, $tmp );
130 while ( preg_match( '/^(.+)\[([^\]]+)\]$/', $tmp, $m ) ) {
131 array_unshift( $nameKeys, $m[2] );
134 array_unshift( $nameKeys, $tmp );
137 for ( $i = count( $thisKeys ) - 1; $i >= 0; $i-- ) {
138 $keys = array_merge( array_slice( $thisKeys, 0, $i ), $nameKeys );
141 $key = array_shift( $keys );
142 if ( !is_array( $data ) ||
!array_key_exists( $key, $data ) ) {
147 $testValue = (string)$data;
155 * Helper function for isHidden to handle recursive data structures.
157 * @param array $alldata
158 * @param array $params
160 * @throws MWException
162 protected function isHiddenRecurse( array $alldata, array $params ) {
163 $origParams = $params;
164 $op = array_shift( $params );
169 foreach ( $params as $i => $p ) {
170 if ( !is_array( $p ) ) {
171 throw new MWException(
172 "Expected array, found " . gettype( $p ) . " at index $i"
175 if ( !$this->isHiddenRecurse( $alldata, $p ) ) {
182 foreach ( $params as $i => $p ) {
183 if ( !is_array( $p ) ) {
184 throw new MWException(
185 "Expected array, found " . gettype( $p ) . " at index $i"
188 if ( $this->isHiddenRecurse( $alldata, $p ) ) {
195 foreach ( $params as $i => $p ) {
196 if ( !is_array( $p ) ) {
197 throw new MWException(
198 "Expected array, found " . gettype( $p ) . " at index $i"
201 if ( !$this->isHiddenRecurse( $alldata, $p ) ) {
208 foreach ( $params as $i => $p ) {
209 if ( !is_array( $p ) ) {
210 throw new MWException(
211 "Expected array, found " . gettype( $p ) . " at index $i"
214 if ( $this->isHiddenRecurse( $alldata, $p ) ) {
221 if ( count( $params ) !== 1 ) {
222 throw new MWException( "NOT takes exactly one parameter" );
225 if ( !is_array( $p ) ) {
226 throw new MWException(
227 "Expected array, found " . gettype( $p ) . " at index 0"
230 return !$this->isHiddenRecurse( $alldata, $p );
234 if ( count( $params ) !== 2 ) {
235 throw new MWException( "$op takes exactly two parameters" );
237 list( $field, $value ) = $params;
238 if ( !is_string( $field ) ||
!is_string( $value ) ) {
239 throw new MWException( "Parameters for $op must be strings" );
241 $testValue = $this->getNearestFieldByName( $alldata, $field );
244 return ( $value === $testValue );
246 return ( $value !== $testValue );
250 throw new MWException( "Unknown operation" );
252 } catch ( Exception
$ex ) {
253 throw new MWException(
254 "Invalid hide-if specification for $this->mName: " .
255 $ex->getMessage() . " in " . var_export( $origParams, true ),
262 * Test whether this field is supposed to be hidden, based on the values of
263 * the other form fields.
266 * @param array $alldata The data collected from the form
269 public function isHidden( $alldata ) {
270 if ( !$this->mHideIf
) {
274 return $this->isHiddenRecurse( $alldata, $this->mHideIf
);
278 * Override this function if the control can somehow trigger a form
279 * submission that shouldn't actually submit the HTMLForm.
282 * @param string|array $value The value the field was submitted with
283 * @param array $alldata The data collected from the form
285 * @return bool True to cancel the submission
287 public function cancelSubmit( $value, $alldata ) {
292 * Override this function to add specific validation checks on the
293 * field input. Don't forget to call parent::validate() to ensure
294 * that the user-defined callback mValidationCallback is still run
296 * @param string|array $value The value the field was submitted with
297 * @param array $alldata The data collected from the form
299 * @return bool|string|Message True on success, or String/Message error to display, or
300 * false to fail validation without displaying an error.
302 public function validate( $value, $alldata ) {
303 if ( $this->isHidden( $alldata ) ) {
307 if ( isset( $this->mParams
['required'] )
308 && $this->mParams
['required'] !== false
311 return $this->msg( 'htmlform-required' );
314 if ( isset( $this->mValidationCallback
) ) {
315 return ( $this->mValidationCallback
)( $value, $alldata, $this->mParent
);
321 public function filter( $value, $alldata ) {
322 if ( isset( $this->mFilterCallback
) ) {
323 $value = ( $this->mFilterCallback
)( $value, $alldata, $this->mParent
);
330 * Should this field have a label, or is there no input element with the
331 * appropriate id for the label to point to?
333 * @return bool True to output a label, false to suppress
335 protected function needsLabel() {
340 * Tell the field whether to generate a separate label element if its label
345 * @param bool $show Set to false to not generate a label.
348 public function setShowEmptyLabel( $show ) {
349 $this->mShowEmptyLabels
= $show;
353 * Can we assume that the request is an attempt to submit a HTMLForm, as opposed to an attempt to
354 * just view it? This can't normally be distinguished for e.g. checkboxes.
356 * Returns true if the request has a field for a CSRF token (wpEditToken) or a form identifier
357 * (wpFormIdentifier).
359 * @param WebRequest $request
362 protected function isSubmitAttempt( WebRequest
$request ) {
363 return $request->getCheck( 'wpEditToken' ) ||
$request->getCheck( 'wpFormIdentifier' );
367 * Get the value that this input has been set to from a posted form,
368 * or the input's default value if it has not been set.
370 * @param WebRequest $request
371 * @return string The value
373 public function loadDataFromRequest( $request ) {
374 if ( $request->getCheck( $this->mName
) ) {
375 return $request->getText( $this->mName
);
377 return $this->getDefault();
382 * Initialise the object
384 * @param array $params Associative Array. See HTMLForm doc for syntax.
386 * @since 1.22 The 'label' attribute no longer accepts raw HTML, use 'label-raw' instead
387 * @throws MWException
389 public function __construct( $params ) {
390 $this->mParams
= $params;
392 if ( isset( $params['parent'] ) && $params['parent'] instanceof HTMLForm
) {
393 $this->mParent
= $params['parent'];
396 # Generate the label from a message, if possible
397 if ( isset( $params['label-message'] ) ) {
398 $this->mLabel
= $this->getMessage( $params['label-message'] )->parse();
399 } elseif ( isset( $params['label'] ) ) {
400 if ( $params['label'] === ' ' ||
$params['label'] === "\u{00A0}" ) {
401 // Apparently some things set   directly and in an odd format
402 $this->mLabel
= "\u{00A0}";
404 $this->mLabel
= htmlspecialchars( $params['label'] );
406 } elseif ( isset( $params['label-raw'] ) ) {
407 $this->mLabel
= $params['label-raw'];
410 $this->mName
= "wp{$params['fieldname']}";
411 if ( isset( $params['name'] ) ) {
412 $this->mName
= $params['name'];
415 if ( isset( $params['dir'] ) ) {
416 $this->mDir
= $params['dir'];
419 $validName = urlencode( $this->mName
);
420 $validName = str_replace( [ '%5B', '%5D' ], [ '[', ']' ], $validName );
421 if ( $this->mName
!= $validName && !isset( $params['nodata'] ) ) {
422 throw new MWException( "Invalid name '{$this->mName}' passed to " . __METHOD__
);
425 $this->mID
= "mw-input-{$this->mName}";
427 if ( isset( $params['default'] ) ) {
428 $this->mDefault
= $params['default'];
431 if ( isset( $params['id'] ) ) {
433 $validId = urlencode( $id );
435 if ( $id != $validId ) {
436 throw new MWException( "Invalid id '$id' passed to " . __METHOD__
);
442 if ( isset( $params['cssclass'] ) ) {
443 $this->mClass
= $params['cssclass'];
446 if ( isset( $params['csshelpclass'] ) ) {
447 $this->mHelpClass
= $params['csshelpclass'];
450 if ( isset( $params['validation-callback'] ) ) {
451 $this->mValidationCallback
= $params['validation-callback'];
454 if ( isset( $params['filter-callback'] ) ) {
455 $this->mFilterCallback
= $params['filter-callback'];
458 if ( isset( $params['hidelabel'] ) ) {
459 $this->mShowEmptyLabels
= false;
462 if ( isset( $params['hide-if'] ) ) {
463 $this->mHideIf
= $params['hide-if'];
468 * Get the complete table row for the input, including help text,
469 * labels, and whatever.
471 * @param string $value The value to set the input to.
473 * @return string Complete HTML table row.
475 public function getTableRow( $value ) {
476 list( $errors, $errorClass ) = $this->getErrorsAndErrorClass( $value );
477 $inputHtml = $this->getInputHTML( $value );
478 $fieldType = static::class;
479 $helptext = $this->getHelpTextHtmlTable( $this->getHelpText() );
480 $cellAttributes = [];
484 if ( !empty( $this->mParams
['vertical-label'] ) ) {
485 $cellAttributes['colspan'] = 2;
486 $verticalLabel = true;
488 $verticalLabel = false;
491 $label = $this->getLabelHtml( $cellAttributes );
493 $field = Html
::rawElement(
495 [ 'class' => 'mw-input' ] +
$cellAttributes,
496 $inputHtml . "\n$errors"
499 if ( $this->mHideIf
) {
500 $rowAttributes['data-hide-if'] = FormatJson
::encode( $this->mHideIf
);
501 $rowClasses .= ' mw-htmlform-hide-if';
504 if ( $verticalLabel ) {
505 $html = Html
::rawElement( 'tr',
506 $rowAttributes +
[ 'class' => "mw-htmlform-vertical-label $rowClasses" ], $label );
507 $html .= Html
::rawElement( 'tr',
509 'class' => "mw-htmlform-field-$fieldType {$this->mClass} $errorClass $rowClasses"
514 Html
::rawElement( 'tr',
516 'class' => "mw-htmlform-field-$fieldType {$this->mClass} $errorClass $rowClasses"
521 return $html . $helptext;
525 * Get the complete div for the input, including help text,
526 * labels, and whatever.
529 * @param string $value The value to set the input to.
531 * @return string Complete HTML table row.
533 public function getDiv( $value ) {
534 list( $errors, $errorClass ) = $this->getErrorsAndErrorClass( $value );
535 $inputHtml = $this->getInputHTML( $value );
536 $fieldType = static::class;
537 $helptext = $this->getHelpTextHtmlDiv( $this->getHelpText() );
538 $cellAttributes = [];
539 $label = $this->getLabelHtml( $cellAttributes );
543 'mw-htmlform-nolabel' => ( $label === '' )
546 $horizontalLabel = $this->mParams
['horizontal-label'] ??
false;
548 if ( $horizontalLabel ) {
549 $field = "\u{00A0}" . $inputHtml . "\n$errors";
551 $field = Html
::rawElement(
553 [ 'class' => $outerDivClass ] +
$cellAttributes,
554 $inputHtml . "\n$errors"
557 $divCssClasses = [ "mw-htmlform-field-$fieldType",
558 $this->mClass
, $this->mVFormClass
, $errorClass ];
560 $wrapperAttributes = [
561 'class' => $divCssClasses,
563 if ( $this->mHideIf
) {
564 $wrapperAttributes['data-hide-if'] = FormatJson
::encode( $this->mHideIf
);
565 $wrapperAttributes['class'][] = ' mw-htmlform-hide-if';
567 $html = Html
::rawElement( 'div', $wrapperAttributes, $label . $field );
574 * Get the OOUI version of the div. Falls back to getDiv by default.
577 * @param string $value The value to set the input to.
579 * @return OOUI\FieldLayout|OOUI\ActionFieldLayout
581 public function getOOUI( $value ) {
582 $inputField = $this->getInputOOUI( $value );
584 if ( !$inputField ) {
585 // This field doesn't have an OOUI implementation yet at all. Fall back to getDiv() to
586 // generate the whole field, label and errors and all, then wrap it in a Widget.
587 // It might look weird, but it'll work OK.
588 return $this->getFieldLayoutOOUI(
589 new OOUI\
Widget( [ 'content' => new OOUI\
HtmlSnippet( $this->getDiv( $value ) ) ] ),
590 [ 'infusable' => false, 'align' => 'top' ]
595 if ( is_string( $inputField ) ) {
596 // We have an OOUI implementation, but it's not proper, and we got a load of HTML.
597 // Cheat a little and wrap it in a widget. It won't be infusable, though, since client-side
598 // JavaScript doesn't know how to rebuilt the contents.
599 $inputField = new OOUI\
Widget( [ 'content' => new OOUI\
HtmlSnippet( $inputField ) ] );
603 $fieldType = static::class;
604 $help = $this->getHelpText();
605 $errors = $this->getErrorsRaw( $value );
606 foreach ( $errors as &$error ) {
607 $error = new OOUI\
HtmlSnippet( $error );
610 $notices = $this->getNotices();
611 foreach ( $notices as &$notice ) {
612 $notice = new OOUI\
HtmlSnippet( $notice );
616 'classes' => [ "mw-htmlform-field-$fieldType", $this->mClass
],
617 'align' => $this->getLabelAlignOOUI(),
618 'help' => ( $help !== null && $help !== '' ) ?
new OOUI\
HtmlSnippet( $help ) : null,
620 'notices' => $notices,
621 'infusable' => $infusable,
622 'helpInline' => $this->isHelpInline(),
625 $preloadModules = false;
627 if ( $infusable && $this->shouldInfuseOOUI() ) {
628 $preloadModules = true;
629 $config['classes'][] = 'mw-htmlform-field-autoinfuse';
632 // the element could specify, that the label doesn't need to be added
633 $label = $this->getLabel();
634 if ( $label && $label !== "\u{00A0}" && $label !== ' ' ) {
635 $config['label'] = new OOUI\
HtmlSnippet( $label );
638 if ( $this->mHideIf
) {
639 $preloadModules = true;
640 $config['hideIf'] = $this->mHideIf
;
643 $config['modules'] = $this->getOOUIModules();
645 if ( $preloadModules ) {
646 $this->mParent
->getOutput()->addModules( 'mediawiki.htmlform.ooui' );
647 $this->mParent
->getOutput()->addModules( $this->getOOUIModules() );
650 return $this->getFieldLayoutOOUI( $inputField, $config );
654 * Get label alignment when generating field for OOUI.
655 * @return string 'left', 'right', 'top' or 'inline'
657 protected function getLabelAlignOOUI() {
662 * Get a FieldLayout (or subclass thereof) to wrap this field in when using OOUI output.
663 * @param string $inputField
664 * @param array $config
665 * @return OOUI\FieldLayout|OOUI\ActionFieldLayout
667 protected function getFieldLayoutOOUI( $inputField, $config ) {
668 if ( isset( $this->mClassWithButton
) ) {
669 $buttonWidget = $this->mClassWithButton
->getInputOOUI( '' );
670 return new HTMLFormActionFieldLayout( $inputField, $buttonWidget, $config );
672 return new HTMLFormFieldLayout( $inputField, $config );
676 * Whether the field should be automatically infused. Note that all OOUI HTMLForm fields are
677 * infusable (you can call OO.ui.infuse() on them), but not all are infused by default, since
678 * there is no benefit in doing it e.g. for buttons and it's a small performance hit on page load.
682 protected function shouldInfuseOOUI() {
683 // Always infuse fields with popup help text, since the interface for it is nicer with JS
684 return $this->getHelpText() !== null && !$this->isHelpInline();
688 * Get the list of extra ResourceLoader modules which must be loaded client-side before it's
689 * possible to infuse this field's OOUI widget.
693 protected function getOOUIModules() {
698 * Get the complete raw fields for the input, including help text,
699 * labels, and whatever.
702 * @param string $value The value to set the input to.
704 * @return string Complete HTML table row.
706 public function getRaw( $value ) {
707 list( $errors, ) = $this->getErrorsAndErrorClass( $value );
708 $inputHtml = $this->getInputHTML( $value );
709 $helptext = $this->getHelpTextHtmlRaw( $this->getHelpText() );
710 $cellAttributes = [];
711 $label = $this->getLabelHtml( $cellAttributes );
722 * Get the complete field for the input, including help text,
723 * labels, and whatever. Fall back from 'vform' to 'div' when not overridden.
726 * @param string $value The value to set the input to.
727 * @return string Complete HTML field.
729 public function getVForm( $value ) {
731 $this->mVFormClass
= ' mw-ui-vform-field';
732 return $this->getDiv( $value );
736 * Get the complete field as an inline element.
738 * @param string $value The value to set the input to.
739 * @return string Complete HTML inline element
741 public function getInline( $value ) {
742 list( $errors, $errorClass ) = $this->getErrorsAndErrorClass( $value );
743 $inputHtml = $this->getInputHTML( $value );
744 $helptext = $this->getHelpTextHtmlDiv( $this->getHelpText() );
745 $cellAttributes = [];
746 $label = $this->getLabelHtml( $cellAttributes );
748 $html = "\n" . $errors .
749 $label . "\u{00A0}" .
757 * Generate help text HTML in table format
760 * @param string|null $helptext
763 public function getHelpTextHtmlTable( $helptext ) {
764 if ( is_null( $helptext ) ) {
769 if ( $this->mHideIf
) {
770 $rowAttributes['data-hide-if'] = FormatJson
::encode( $this->mHideIf
);
771 $rowAttributes['class'] = 'mw-htmlform-hide-if';
774 $tdClasses = [ 'htmlform-tip' ];
775 if ( $this->mHelpClass
!== false ) {
776 $tdClasses[] = $this->mHelpClass
;
778 $row = Html
::rawElement( 'td', [ 'colspan' => 2, 'class' => $tdClasses ], $helptext );
779 $row = Html
::rawElement( 'tr', $rowAttributes, $row );
785 * Generate help text HTML in div format
788 * @param string|null $helptext
792 public function getHelpTextHtmlDiv( $helptext ) {
793 if ( is_null( $helptext ) ) {
797 $wrapperAttributes = [
798 'class' => 'htmlform-tip',
800 if ( $this->mHelpClass
!== false ) {
801 $wrapperAttributes['class'] .= " {$this->mHelpClass}";
803 if ( $this->mHideIf
) {
804 $wrapperAttributes['data-hide-if'] = FormatJson
::encode( $this->mHideIf
);
805 $wrapperAttributes['class'] .= ' mw-htmlform-hide-if';
807 $div = Html
::rawElement( 'div', $wrapperAttributes, $helptext );
813 * Generate help text HTML formatted for raw output
816 * @param string|null $helptext
819 public function getHelpTextHtmlRaw( $helptext ) {
820 return $this->getHelpTextHtmlDiv( $helptext );
824 * Determine the help text to display
826 * @return string|null HTML
828 public function getHelpText() {
831 if ( isset( $this->mParams
['help-message'] ) ) {
832 $this->mParams
['help-messages'] = [ $this->mParams
['help-message'] ];
835 if ( isset( $this->mParams
['help-messages'] ) ) {
836 foreach ( $this->mParams
['help-messages'] as $msg ) {
837 $msg = $this->getMessage( $msg );
839 if ( $msg->exists() ) {
840 if ( is_null( $helptext ) ) {
843 $helptext .= $this->msg( 'word-separator' )->escaped(); // some space
845 $helptext .= $msg->parse(); // Append message
848 } elseif ( isset( $this->mParams
['help'] ) ) {
849 $helptext = $this->mParams
['help'];
856 * Determine if the help text should be displayed inline.
858 * Only applies to OOUI forms.
863 public function isHelpInline() {
864 return isset( $this->mParams
['help-inline'] ) ?
$this->mParams
['help-inline'] : true;
868 * Determine form errors to display and their classes
871 * @param string $value The value of the input
872 * @return array array( $errors, $errorClass )
874 public function getErrorsAndErrorClass( $value ) {
875 $errors = $this->validate( $value, $this->mParent
->mFieldData
);
877 if ( is_bool( $errors ) ||
!$this->mParent
->wasSubmitted() ) {
881 $errors = self
::formatErrors( $errors );
882 $errorClass = 'mw-htmlform-invalid-input';
885 return [ $errors, $errorClass ];
889 * Determine form errors to display, returning them in an array.
892 * @param string $value The value of the input
893 * @return string[] Array of error HTML strings
895 public function getErrorsRaw( $value ) {
896 $errors = $this->validate( $value, $this->mParent
->mFieldData
);
898 if ( is_bool( $errors ) ||
!$this->mParent
->wasSubmitted() ) {
902 if ( !is_array( $errors ) ) {
903 $errors = [ $errors ];
905 foreach ( $errors as &$error ) {
906 if ( $error instanceof Message
) {
907 $error = $error->parse();
915 * Determine notices to display for the field.
920 public function getNotices() {
923 if ( isset( $this->mParams
['notice-message'] ) ) {
924 $notices[] = $this->getMessage( $this->mParams
['notice-message'] )->parse();
927 if ( isset( $this->mParams
['notice-messages'] ) ) {
928 foreach ( $this->mParams
['notice-messages'] as $msg ) {
929 $notices[] = $this->getMessage( $msg )->parse();
931 } elseif ( isset( $this->mParams
['notice'] ) ) {
932 $notices[] = $this->mParams
['notice'];
939 * @return string HTML
941 public function getLabel() {
942 return $this->mLabel ??
'';
945 public function getLabelHtml( $cellAttributes = [] ) {
946 # Don't output a for= attribute for labels with no associated input.
947 # Kind of hacky here, possibly we don't want these to be <label>s at all.
950 if ( $this->needsLabel() ) {
951 $for['for'] = $this->mID
;
954 $labelValue = trim( $this->getLabel() );
956 if ( $labelValue !== "\u{00A0}" && $labelValue !== ' ' && $labelValue !== '' ) {
960 $displayFormat = $this->mParent
->getDisplayFormat();
962 $horizontalLabel = $this->mParams
['horizontal-label'] ??
false;
964 if ( $displayFormat === 'table' ) {
966 Html
::rawElement( 'td',
967 [ 'class' => 'mw-label' ] +
$cellAttributes,
968 Html
::rawElement( 'label', $for, $labelValue ) );
969 } elseif ( $hasLabel ||
$this->mShowEmptyLabels
) {
970 if ( $displayFormat === 'div' && !$horizontalLabel ) {
972 Html
::rawElement( 'div',
973 [ 'class' => 'mw-label' ] +
$cellAttributes,
974 Html
::rawElement( 'label', $for, $labelValue ) );
976 $html = Html
::rawElement( 'label', $for, $labelValue );
983 public function getDefault() {
984 return $this->mDefault ??
null;
988 * Returns the attributes required for the tooltip and accesskey, for Html::element() etc.
990 * @return array Attributes
992 public function getTooltipAndAccessKey() {
993 if ( empty( $this->mParams
['tooltip'] ) ) {
997 return Linker
::tooltipAndAccesskeyAttribs( $this->mParams
['tooltip'] );
1001 * Returns the attributes required for the tooltip and accesskey, for OOUI widgets' config.
1003 * @return array Attributes
1005 public function getTooltipAndAccessKeyOOUI() {
1006 if ( empty( $this->mParams
['tooltip'] ) ) {
1011 'title' => Linker
::titleAttrib( $this->mParams
['tooltip'] ),
1012 'accessKey' => Linker
::accesskey( $this->mParams
['tooltip'] ),
1017 * Returns the given attributes from the parameters
1019 * @param array $list List of attributes to get
1020 * @return array Attributes
1022 public function getAttributes( array $list ) {
1023 static $boolAttribs = [ 'disabled', 'required', 'autofocus', 'multiple', 'readonly' ];
1026 foreach ( $list as $key ) {
1027 if ( in_array( $key, $boolAttribs ) ) {
1028 if ( !empty( $this->mParams
[$key] ) ) {
1031 } elseif ( isset( $this->mParams
[$key] ) ) {
1032 $ret[$key] = $this->mParams
[$key];
1040 * Given an array of msg-key => value mappings, returns an array with keys
1041 * being the message texts. It also forces values to strings.
1043 * @param array $options
1046 private function lookupOptionsKeys( $options ) {
1048 foreach ( $options as $key => $value ) {
1049 $key = $this->msg( $key )->plain();
1050 $ret[$key] = is_array( $value )
1051 ?
$this->lookupOptionsKeys( $value )
1058 * Recursively forces values in an array to strings, because issues arise
1059 * with integer 0 as a value.
1061 * @param array $array
1062 * @return array|string
1064 public static function forceToStringRecursive( $array ) {
1065 if ( is_array( $array ) ) {
1066 return array_map( [ __CLASS__
, 'forceToStringRecursive' ], $array );
1068 return strval( $array );
1073 * Fetch the array of options from the field's parameters. In order, this
1074 * checks 'options-messages', 'options', then 'options-message'.
1076 * @return array|null Options array
1078 public function getOptions() {
1079 if ( $this->mOptions
=== false ) {
1080 if ( array_key_exists( 'options-messages', $this->mParams
) ) {
1081 $this->mOptions
= $this->lookupOptionsKeys( $this->mParams
['options-messages'] );
1082 } elseif ( array_key_exists( 'options', $this->mParams
) ) {
1083 $this->mOptionsLabelsNotFromMessage
= true;
1084 $this->mOptions
= self
::forceToStringRecursive( $this->mParams
['options'] );
1085 } elseif ( array_key_exists( 'options-message', $this->mParams
) ) {
1086 $message = $this->getMessage( $this->mParams
['options-message'] )->inContentLanguage()->plain();
1087 $this->mOptions
= Xml
::listDropDownOptions( $message );
1089 $this->mOptions
= null;
1093 return $this->mOptions
;
1097 * Get options and make them into arrays suitable for OOUI.
1098 * @return array Options for inclusion in a select or whatever.
1100 public function getOptionsOOUI() {
1101 $oldoptions = $this->getOptions();
1103 if ( $oldoptions === null ) {
1107 return Xml
::listDropDownOptionsOoui( $oldoptions );
1111 * flatten an array of options to a single array, for instance,
1112 * a set of "<options>" inside "<optgroups>".
1114 * @param array $options Associative Array with values either Strings or Arrays
1115 * @return array Flattened input
1117 public static function flattenOptions( $options ) {
1120 foreach ( $options as $value ) {
1121 if ( is_array( $value ) ) {
1122 $flatOpts = array_merge( $flatOpts, self
::flattenOptions( $value ) );
1124 $flatOpts[] = $value;
1132 * Formats one or more errors as accepted by field validation-callback.
1134 * @param string|Message|array $errors Array of strings or Message instances
1135 * @return string HTML
1138 protected static function formatErrors( $errors ) {
1139 // Note: If you change the logic in this method, change
1140 // htmlform.Checker.js to match.
1142 if ( is_array( $errors ) && count( $errors ) === 1 ) {
1143 $errors = array_shift( $errors );
1146 if ( is_array( $errors ) ) {
1148 foreach ( $errors as $error ) {
1149 if ( $error instanceof Message
) {
1150 $lines[] = Html
::rawElement( 'li', [], $error->parse() );
1152 $lines[] = Html
::rawElement( 'li', [], $error );
1156 return Html
::rawElement( 'ul', [ 'class' => 'error' ], implode( "\n", $lines ) );
1158 if ( $errors instanceof Message
) {
1159 $errors = $errors->parse();
1162 return Html
::rawElement( 'span', [ 'class' => 'error' ], $errors );
1167 * Turns a *-message parameter (which could be a MessageSpecifier, or a message name, or a
1168 * name + parameters array) into a Message.
1169 * @param mixed $value
1172 protected function getMessage( $value ) {
1173 $message = Message
::newFromSpecifier( $value );
1175 if ( $this->mParent
) {
1176 $message->setContext( $this->mParent
);
1183 * Skip this field when collecting data.
1184 * @param WebRequest $request
1188 public function skipLoadData( $request ) {
1189 return !empty( $this->mParams
['nodata'] );
1193 * Whether this field requires the user agent to have JavaScript enabled for the client-side HTML5
1194 * form validation to work correctly.
1199 public function needsJSForHtml5FormValidation() {
1200 if ( $this->mHideIf
) {
1201 // This is probably more restrictive than it needs to be, but better safe than sorry