50 public static function element( $element, $attribs =
null, $contents =
'',
53 $out =
'<' . $element;
54 if ( $attribs !==
null ) {
55 $out .= self::expandAttributes( $attribs );
57 if ( $contents ===
null ) {
59 } elseif ( $allowShortTag && $contents ===
'' ) {
62 $out .=
'>' . htmlspecialchars( $contents, ENT_NOQUOTES ) .
"</$element>";
76 if ( $attribs ===
null ) {
80 foreach ( $attribs as $name => $val ) {
81 $out .=
" {$name}=\"" . Sanitizer::encodeAttribute( $val ) .
'"';
97 public static function elementClean( $element, $attribs = [], $contents =
'' ) {
99 $attribs = array_map( [ UtfNormal\Validator::class,
'cleanUp' ], $attribs );
103 MediaWikiServices::getInstance()->getContentLanguage()->normalize( $contents );
105 return self::element( $element, $attribs, $contents );
116 return '<' . $element . self::expandAttributes( $attribs ) .
'>';
125 return "</$element>";
141 public static function tags( $element, $attribs, $contents ) {
142 return self::openElement( $element, $attribs ) . $contents .
"</$element>";
154 public static function monthSelector( $selected =
'', $allmonths =
null, $id =
'month' ) {
158 $data =
new XmlSelect(
'month', $id, $selected ??
'' );
160 if ( $allmonths !==
null ) {
161 $options[
wfMessage(
'monthsall' )->text()] = $allmonths;
163 for ( $i = 1; $i < 13; $i++ ) {
164 $options[
$wgLang->getMonthName( $i )] = $i;
166 $data->addOptions( $options );
167 $data->setAttribute(
'class',
'mw-month-selector' );
168 return $data->getHTML();
178 # Offset overrides year/month selection
179 if ( $month && $month !== -1 ) {
180 $encMonth = intval( $month );
185 $encYear = intval( $year );
186 } elseif ( $encMonth ) {
187 $timestamp = MWTimestamp::getInstance();
188 $thisMonth = intval( $timestamp->format(
'n' ) );
189 $thisYear = intval( $timestamp->format(
'Y' ) );
190 if ( $encMonth > $thisMonth ) {
193 $encYear = $thisYear;
197 $inputAttribs = [
'id' =>
'year',
'maxlength' => 4,
'size' => 7 ];
198 return self::label(
wfMessage(
'year' )->text(),
'year' ) .
' ' .
199 Html::input(
'year', $encYear,
'number', $inputAttribs ) .
' ' .
200 self::label(
wfMessage(
'month' )->text(),
'month' ) .
' ' .
201 self::monthSelector( $encMonth,
'-1' );
215 $inLanguage =
null, $overrideAttrs = [], Message $msg =
null
217 $languageCode = MediaWikiServices::getInstance()->getMainConfig()
218 ->get( MainConfigNames::LanguageCode );
220 $include = $customisedOnly ? LanguageNameUtils::SUPPORTED : LanguageNameUtils::DEFINED;
221 $languages = MediaWikiServices::getInstance()
222 ->getLanguageNameUtils()
223 ->getLanguageNames( $inLanguage, $include );
227 if ( !array_key_exists( $languageCode, $languages ) ) {
228 $languages[$languageCode] = $languageCode;
238 $selected = isset( $languages[$selected] ) ? $selected : $languageCode;
240 foreach ( $languages as $code => $name ) {
241 $options .= self::option(
"$code - $name", $code, $code == $selected ) .
"\n";
244 $attrs = [
'id' =>
'wpUserLanguage',
'name' =>
'wpUserLanguage' ];
245 $attrs = array_merge( $attrs, $overrideAttrs );
247 if ( $msg ===
null ) {
251 self::label( $msg->text(), $attrs[
'id'] ),
252 self::tags(
'select', $attrs, $options )
264 public static function span( $text, $class, $attribs = [] ) {
265 return self::element(
'span', [
'class' => $class ] + $attribs, $text );
278 public static function wrapClass( $text, $class, $tag =
'span', $attribs = [] ) {
280 return self::tags( $tag, [
'class' => $class ] + $attribs, $text );
292 public static function input( $name, $size =
false, $value =
false, $attribs = [] ) {
293 $attributes = [
'name' => $name ];
296 $attributes[
'size'] = $size;
299 if ( $value !==
false ) {
300 $attributes[
'value'] = $value;
303 return self::element(
'input', $attributes + $attribs );
315 public static function password( $name, $size =
false, $value =
false,
318 return self::input( $name, $size, $value,
319 array_merge( $attribs, [
'type' =>
'password' ] ) );
330 public static function attrib( $name, $present =
true ) {
331 return $present ? [ $name => $name ] : [];
342 public static function check( $name, $checked =
false, $attribs = [] ) {
343 return self::element(
'input', array_merge(
346 'type' =>
'checkbox',
348 self::attrib(
'checked', $checked ),
361 public static function radio( $name, $value, $checked =
false, $attribs = [] ) {
362 return self::element(
'input', [
365 'value' => $value ] + self::attrib(
'checked', $checked ) + $attribs );
379 public static function label( $label, $id, $attribs = [] ) {
380 $a = [
'for' => $id ];
382 foreach ( [
'class',
'title' ] as $attr ) {
383 if ( isset( $attribs[$attr] ) ) {
384 $a[$attr] = $attribs[$attr];
388 return self::element(
'label', $a, $label );
402 public static function inputLabel( $label, $name, $id, $size =
false,
403 $value =
false, $attribs = []
405 [ $label, $input ] = self::inputLabelSep( $label, $name, $id, $size, $value, $attribs );
406 return $label .
"\u{00A0}" . $input;
423 $value =
false, $attribs = []
426 self::label( $label, $id, $attribs ),
427 self::input( $name, $size, $value, [
'id' => $id ] + $attribs )
443 public static function checkLabel( $label, $name, $id, $checked =
false, $attribs = [] ) {
444 return self::check( $name, $checked, [
'id' => $id ] + $attribs ) .
446 self::label( $label, $id, $attribs );
462 public static function radioLabel( $label, $name, $value, $id,
463 $checked =
false, $attribs = []
465 return self::radio( $name, $value, $checked, [
'id' => $id ] + $attribs ) .
467 self::label( $label, $id, $attribs );
483 return Html::element(
'input', $attribs );
495 public static function option( $text, $value =
null, $selected =
false,
497 if ( $value !==
null ) {
498 $attribs[
'value'] = $value;
501 $attribs[
'selected'] =
'selected';
503 return Html::element(
'option', $attribs, $text );
519 public static function listDropdown( $name =
'', $list =
'', $other =
'',
520 $selected =
'', $class =
'', $tabindex =
null
522 $options = self::listDropdownOptions( $list, [
'other' => $other ] );
524 $xmlSelect =
new XmlSelect( $name, $name, $selected );
525 $xmlSelect->addOptions( $options );
528 $xmlSelect->setAttribute(
'class', $class );
531 $xmlSelect->setAttribute(
'tabindex', $tabindex );
534 return $xmlSelect->getHTML();
553 if ( isset(
$params[
'other'] ) ) {
554 $options[
$params[
'other'] ] =
'other';
558 foreach ( explode(
"\n", $list ) as $option ) {
559 $value = trim( $option );
560 if ( $value ==
'' ) {
563 if ( substr( $value, 0, 1 ) ==
'*' && substr( $value, 1, 1 ) !=
'*' ) {
564 # A new group is starting...
565 $value = trim( substr( $value, 1 ) );
566 if ( $value !==
'' &&
574 } elseif ( substr( $value, 0, 2 ) ==
'**' ) {
576 $opt = trim( substr( $value, 2 ) );
577 if ( $optgroup ===
false ) {
578 $options[$opt] = $opt;
580 $options[$optgroup][$opt] = $opt;
583 # groupless reason list
585 $options[$option] = $option;
603 foreach ( $options as $text => $value ) {
604 if ( is_array( $value ) ) {
605 $optionsOoui[] = [
'optgroup' => (string)$text ];
606 foreach ( $value as $text2 => $value2 ) {
607 $optionsOoui[] = [
'data' => (string)$value2,
'label' => (
string)$text2 ];
610 $optionsOoui[] = [
'data' => (string)$value,
'label' => (
string)$text ];
629 public static function fieldset( $legend =
false, $content =
false, $attribs = [] ) {
630 $s = self::openElement(
'fieldset', $attribs ) .
"\n";
633 $s .= self::element(
'legend',
null, $legend ) .
"\n";
636 if ( $content !==
false ) {
637 $s .= $content .
"\n";
638 $s .= self::closeElement(
'fieldset' ) .
"\n";
656 public static function textarea( $name, $content, $cols = 40, $rows = 5, $attribs = [] ) {
657 return self::element(
'textarea',
682 return Html::encodeJsVar( $value, $pretty );
701 return Html::encodeJsCall( $name, $args, $pretty );
715 private static function isWellFormed( $text ) {
716 $parser = xml_parser_create(
"UTF-8" );
718 # case folding violates XML standard, turn it off
719 xml_parser_set_option( $parser, XML_OPTION_CASE_FOLDING, 0 );
721 if ( !xml_parse( $parser, $text,
true ) ) {
726 xml_parser_free( $parser );
730 xml_parser_free( $parser );
745 Sanitizer::hackDocType() .
750 return self::isWellFormed( $html );
763 [
'"',
'>',
'<' ],
779 public static function buildForm( $fields, $submitLabel =
null, $submitAttribs = [] ) {
781 $form .=
"<table><tbody>";
783 foreach ( $fields as $labelmsg => $input ) {
784 $id =
"mw-$labelmsg";
785 $form .= self::openElement(
'tr', [
'id' => $id ] );
791 $form .= self::tags(
'td', [
'class' =>
'mw-label' ],
wfMessage( $labelmsg )->parse() );
792 $form .= self::openElement(
'td', [
'class' =>
'mw-input' ] )
793 . $input . self::closeElement(
'td' );
794 $form .= self::closeElement(
'tr' );
797 if ( $submitLabel ) {
798 $form .= self::openElement(
'tr' );
799 $form .= self::tags(
'td', [],
'' );
800 $form .= self::openElement(
'td', [
'class' =>
'mw-submit' ] )
801 . self::submitButton(
wfMessage( $submitLabel )->text(), $submitAttribs )
802 . self::closeElement(
'td' );
803 $form .= self::closeElement(
'tr' );
806 $form .=
"</tbody></table>";
817 public static function buildTable( $rows, $attribs = [], $headers =
null ) {
818 $s = self::openElement(
'table', $attribs );
820 if ( is_array( $headers ) ) {
821 $s .= self::openElement(
'thead', $attribs );
823 foreach ( $headers as $id =>
$header ) {
826 if ( is_string( $id ) ) {
827 $attribs[
'id'] = $id;
830 $s .= self::element(
'th', $attribs,
$header );
832 $s .= self::closeElement(
'thead' );
835 foreach ( $rows as $id => $row ) {
838 if ( is_string( $id ) ) {
839 $attribs[
'id'] = $id;
842 $s .= self::buildTableRow( $attribs, $row );
845 $s .= self::closeElement(
'table' );
857 $s = self::openElement(
'tr', $attribs );
859 foreach ( $cells as $id => $cell ) {
862 if ( is_string( $id ) ) {
863 $attribs[
'id'] = $id;
866 $s .= self::element(
'td', $attribs, $cell );
869 $s .= self::closeElement(
'tr' );
wfMessage( $key,... $params)
This is the function for getting translated interface messages.
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Logs a warning that a deprecated feature was used.
if(!defined( 'MW_NO_SESSION') &&MW_ENTRY_POINT !=='cli') $wgLang
array $params
The job parameters.
A class containing constants representing the names of configuration variables.
Class for generating HTML <select> or <datalist> elements.
Module of static functions for generating XML.
static password( $name, $size=false, $value=false, $attribs=[])
Convenience function to build an HTML password input field.
static closeElement( $element)
Shortcut to close an XML element.
static textarea( $name, $content, $cols=40, $rows=5, $attribs=[])
Shortcut for creating textareas.
static inputLabelSep( $label, $name, $id, $size=false, $value=false, $attribs=[])
Same as Xml::inputLabel() but return input and label in an array.
static encodeJsVar( $value, $pretty=false)
Encode a variable of arbitrary type to JavaScript.
static isWellFormedXmlFragment( $text)
Check if a string is a well-formed XML fragment.
static check( $name, $checked=false, $attribs=[])
Convenience function to build an HTML checkbox.
static dateMenu( $year, $month)
static buildForm( $fields, $submitLabel=null, $submitAttribs=[])
Generate a form (without the opening form element).
static listDropdownOptionsOoui( $options)
Convert options for a drop-down box into a format accepted by OOUI\DropdownInputWidget etc.
static listDropdown( $name='', $list='', $other='', $selected='', $class='', $tabindex=null)
Build a drop-down box from a textual list.
static attrib( $name, $present=true)
Internal function for use in checkboxes and radio buttons and such.
static label( $label, $id, $attribs=[])
Convenience function to build an HTML form label.
static openElement( $element, $attribs=null)
This opens an XML element.
static input( $name, $size=false, $value=false, $attribs=[])
Convenience function to build an HTML text input field.
static wrapClass( $text, $class, $tag='span', $attribs=[])
Shortcut to make a specific element with a class attribute.
static buildTable( $rows, $attribs=[], $headers=null)
static listDropdownOptions( $list, $params=[])
Build options for a drop-down box from a textual list.
static submitButton( $value, $attribs=[])
Convenience function to build an HTML submit button.
static option( $text, $value=null, $selected=false, $attribs=[])
Convenience function to build an HTML drop-down list item.
static checkLabel( $label, $name, $id, $checked=false, $attribs=[])
Convenience function to build an HTML checkbox with a label.
static inputLabel( $label, $name, $id, $size=false, $value=false, $attribs=[])
Convenience function to build an HTML text input field with a label.
static languageSelector( $selected, $customisedOnly=true, $inLanguage=null, $overrideAttrs=[], Message $msg=null)
Construct a language selector appropriate for use in a form or preferences.
static span( $text, $class, $attribs=[])
Shortcut to make a span element.
static escapeTagsOnly( $in)
Replace " > and < with their respective HTML entities ( ", >, <)
static tags( $element, $attribs, $contents)
Same as Xml::element(), but does not escape contents.
static element( $element, $attribs=null, $contents='', $allowShortTag=true)
Format an XML element with given attributes and, optionally, text content.
static radio( $name, $value, $checked=false, $attribs=[])
Convenience function to build an HTML radio button.
static buildTableRow( $attribs, $cells)
Build a row for a table.
static radioLabel( $label, $name, $value, $id, $checked=false, $attribs=[])
Convenience function to build an HTML radio button with a label.
static encodeJsCall( $name, $args, $pretty=false)
Create a call to a JavaScript function.
static expandAttributes(?array $attribs)
Given an array of ('attributename' => 'value'), it generates the code to set the XML attributes : att...
static monthSelector( $selected='', $allmonths=null, $id='month')
Create a date selector.
static fieldset( $legend=false, $content=false, $attribs=[])
Shortcut for creating fieldsets.
static elementClean( $element, $attribs=[], $contents='')
Format an XML element as with self::element(), but run text through the content language's normalize(...