MediaWiki  master
Xml.php
Go to the documentation of this file.
1 <?php
24 
28 class Xml {
41  public static function element( $element, $attribs = null, $contents = '',
42  $allowShortTag = true
43  ) {
44  $out = '<' . $element;
45  if ( !is_null( $attribs ) ) {
46  $out .= self::expandAttributes( $attribs );
47  }
48  if ( is_null( $contents ) ) {
49  $out .= '>';
50  } elseif ( $allowShortTag && $contents === '' ) {
51  $out .= ' />';
52  } else {
53  $out .= '>' . htmlspecialchars( $contents, ENT_NOQUOTES ) . "</$element>";
54  }
55  return $out;
56  }
57 
67  public static function expandAttributes( $attribs ) {
68  $out = '';
69  if ( is_null( $attribs ) ) {
70  return null;
71  } elseif ( is_array( $attribs ) ) {
72  foreach ( $attribs as $name => $val ) {
73  $out .= " {$name}=\"" . Sanitizer::encodeAttribute( $val ) . '"';
74  }
75  return $out;
76  } else {
77  throw new MWException( 'Expected attribute array, got something else in ' . __METHOD__ );
78  }
79  }
80 
90  public static function elementClean( $element, $attribs = [], $contents = '' ) {
91  if ( $attribs ) {
92  $attribs = array_map( [ 'UtfNormal\Validator', 'cleanUp' ], $attribs );
93  }
94  if ( $contents ) {
95  $contents =
96  MediaWikiServices::getInstance()->getContentLanguage()->normalize( $contents );
97  }
98  return self::element( $element, $attribs, $contents );
99  }
100 
108  public static function openElement( $element, $attribs = null ) {
109  return '<' . $element . self::expandAttributes( $attribs ) . '>';
110  }
111 
117  public static function closeElement( $element ) {
118  return "</$element>";
119  }
120 
130  public static function tags( $element, $attribs, $contents ) {
131  return self::openElement( $element, $attribs ) . $contents . "</$element>";
132  }
133 
143  public static function monthSelector( $selected = '', $allmonths = null, $id = 'month' ) {
144  global $wgLang;
145  $options = [];
146  $data = new XmlSelect( 'month', $id, $selected );
147  if ( is_null( $selected ) ) {
148  $selected = '';
149  }
150  if ( !is_null( $allmonths ) ) {
151  $options[wfMessage( 'monthsall' )->text()] = $allmonths;
152  }
153  for ( $i = 1; $i < 13; $i++ ) {
154  $options[$wgLang->getMonthName( $i )] = $i;
155  }
156  $data->addOptions( $options );
157  $data->setAttribute( 'class', 'mw-month-selector' );
158  return $data->getHTML();
159  }
160 
167  public static function dateMenu( $year, $month ) {
168  # Offset overrides year/month selection
169  if ( $month && $month !== -1 ) {
170  $encMonth = intval( $month );
171  } else {
172  $encMonth = '';
173  }
174  if ( $year ) {
175  $encYear = intval( $year );
176  } elseif ( $encMonth ) {
177  $timestamp = MWTimestamp::getInstance();
178  $thisMonth = intval( $timestamp->format( 'n' ) );
179  $thisYear = intval( $timestamp->format( 'Y' ) );
180  if ( intval( $encMonth ) > $thisMonth ) {
181  $thisYear--;
182  }
183  $encYear = $thisYear;
184  } else {
185  $encYear = '';
186  }
187  $inputAttribs = [ 'id' => 'year', 'maxlength' => 4, 'size' => 7 ];
188  return self::label( wfMessage( 'year' )->text(), 'year' ) . ' ' .
189  Html::input( 'year', $encYear, 'number', $inputAttribs ) . ' ' .
190  self::label( wfMessage( 'month' )->text(), 'month' ) . ' ' .
191  self::monthSelector( $encMonth, -1 );
192  }
193 
204  public static function languageSelector( $selected, $customisedOnly = true,
205  $inLanguage = null, $overrideAttrs = [], Message $msg = null
206  ) {
207  global $wgLanguageCode;
208 
209  $include = $customisedOnly ? 'mwfile' : 'mw';
210  $languages = Language::fetchLanguageNames( $inLanguage, $include );
211 
212  // Make sure the site language is in the list;
213  // a custom language code might not have a defined name...
214  if ( !array_key_exists( $wgLanguageCode, $languages ) ) {
216  // Sort the array again
217  ksort( $languages );
218  }
219 
225  $selected = isset( $languages[$selected] ) ? $selected : $wgLanguageCode;
226  $options = "\n";
227  foreach ( $languages as $code => $name ) {
228  $options .= self::option( "$code - $name", $code, $code == $selected ) . "\n";
229  }
230 
231  $attrs = [ 'id' => 'wpUserLanguage', 'name' => 'wpUserLanguage' ];
232  $attrs = array_merge( $attrs, $overrideAttrs );
233 
234  if ( $msg === null ) {
235  $msg = wfMessage( 'yourlanguage' );
236  }
237  return [
238  self::label( $msg->text(), $attrs['id'] ),
239  self::tags( 'select', $attrs, $options )
240  ];
241  }
242 
250  public static function span( $text, $class, $attribs = [] ) {
251  return self::element( 'span', [ 'class' => $class ] + $attribs, $text );
252  }
253 
262  public static function wrapClass( $text, $class, $tag = 'span', $attribs = [] ) {
263  return self::tags( $tag, [ 'class' => $class ] + $attribs, $text );
264  }
265 
274  public static function input( $name, $size = false, $value = false, $attribs = [] ) {
275  $attributes = [ 'name' => $name ];
276 
277  if ( $size ) {
278  $attributes['size'] = $size;
279  }
280 
281  if ( $value !== false ) { // maybe 0
282  $attributes['value'] = $value;
283  }
284 
285  return self::element( 'input',
286  Html::getTextInputAttributes( $attributes + $attribs ) );
287  }
288 
297  public static function password( $name, $size = false, $value = false,
298  $attribs = []
299  ) {
300  return self::input( $name, $size, $value,
301  array_merge( $attribs, [ 'type' => 'password' ] ) );
302  }
303 
312  public static function attrib( $name, $present = true ) {
313  return $present ? [ $name => $name ] : [];
314  }
315 
323  public static function check( $name, $checked = false, $attribs = [] ) {
324  return self::element( 'input', array_merge(
325  [
326  'name' => $name,
327  'type' => 'checkbox',
328  'value' => 1 ],
329  self::attrib( 'checked', $checked ),
330  $attribs ) );
331  }
332 
341  public static function radio( $name, $value, $checked = false, $attribs = [] ) {
342  return self::element( 'input', [
343  'name' => $name,
344  'type' => 'radio',
345  'value' => $value ] + self::attrib( 'checked', $checked ) + $attribs );
346  }
347 
358  public static function label( $label, $id, $attribs = [] ) {
359  $a = [ 'for' => $id ];
360 
361  foreach ( [ 'class', 'title' ] as $attr ) {
362  if ( isset( $attribs[$attr] ) ) {
363  $a[$attr] = $attribs[$attr];
364  }
365  }
366 
367  return self::element( 'label', $a, $label );
368  }
369 
380  public static function inputLabel( $label, $name, $id, $size = false,
381  $value = false, $attribs = []
382  ) {
383  list( $label, $input ) = self::inputLabelSep( $label, $name, $id, $size, $value, $attribs );
384  return $label . "\u{00A0}" . $input;
385  }
386 
399  public static function inputLabelSep( $label, $name, $id, $size = false,
400  $value = false, $attribs = []
401  ) {
402  return [
403  self::label( $label, $id, $attribs ),
404  self::input( $name, $size, $value, [ 'id' => $id ] + $attribs )
405  ];
406  }
407 
419  public static function checkLabel( $label, $name, $id, $checked = false, $attribs = [] ) {
421  $chkLabel = self::check( $name, $checked, [ 'id' => $id ] + $attribs ) .
422  "\u{00A0}" .
423  self::label( $label, $id, $attribs );
424 
425  if ( $wgUseMediaWikiUIEverywhere ) {
426  $chkLabel = self::openElement( 'div', [ 'class' => 'mw-ui-checkbox' ] ) .
427  $chkLabel . self::closeElement( 'div' );
428  }
429  return $chkLabel;
430  }
431 
444  public static function radioLabel( $label, $name, $value, $id,
445  $checked = false, $attribs = []
446  ) {
447  return self::radio( $name, $value, $checked, [ 'id' => $id ] + $attribs ) .
448  "\u{00A0}" .
449  self::label( $label, $id, $attribs );
450  }
451 
459  public static function submitButton( $value, $attribs = [] ) {
461  $baseAttrs = [
462  'type' => 'submit',
463  'value' => $value,
464  ];
465  // Done conditionally for time being as it is possible
466  // some submit forms
467  // might need to be mw-ui-destructive (e.g. delete a page)
468  if ( $wgUseMediaWikiUIEverywhere ) {
469  $baseAttrs['class'] = 'mw-ui-button mw-ui-progressive';
470  }
471  // Any custom attributes will take precendence of anything in baseAttrs e.g. override the class
472  $attribs = $attribs + $baseAttrs;
473  return Html::element( 'input', $attribs );
474  }
475 
484  public static function option( $text, $value = null, $selected = false,
485  $attribs = [] ) {
486  if ( !is_null( $value ) ) {
487  $attribs['value'] = $value;
488  }
489  if ( $selected ) {
490  $attribs['selected'] = 'selected';
491  }
492  return Html::element( 'option', $attribs, $text );
493  }
494 
508  public static function listDropDown( $name = '', $list = '', $other = '',
509  $selected = '', $class = '', $tabindex = null
510  ) {
511  $options = self::listDropDownOptions( $list, [ 'other' => $other ] );
512 
513  $xmlSelect = new XmlSelect( $name, $name, $selected );
514  $xmlSelect->addOptions( $options );
515 
516  if ( $class ) {
517  $xmlSelect->setAttribute( 'class', $class );
518  }
519  if ( $tabindex ) {
520  $xmlSelect->setAttribute( 'tabindex', $tabindex );
521  }
522 
523  return $xmlSelect->getHTML();
524  }
525 
539  public static function listDropDownOptions( $list, $params = [] ) {
540  $options = [];
541 
542  if ( isset( $params['other'] ) ) {
543  $options[ $params['other'] ] = 'other';
544  }
545 
546  $optgroup = false;
547  foreach ( explode( "\n", $list ) as $option ) {
548  $value = trim( $option );
549  if ( $value == '' ) {
550  continue;
551  } elseif ( substr( $value, 0, 1 ) == '*' && substr( $value, 1, 1 ) != '*' ) {
552  # A new group is starting...
553  $value = trim( substr( $value, 1 ) );
554  $optgroup = $value;
555  } elseif ( substr( $value, 0, 2 ) == '**' ) {
556  # groupmember
557  $opt = trim( substr( $value, 2 ) );
558  if ( $optgroup === false ) {
559  $options[$opt] = $opt;
560  } else {
561  $options[$optgroup][$opt] = $opt;
562  }
563  } else {
564  # groupless reason list
565  $optgroup = false;
566  $options[$option] = $option;
567  }
568  }
569 
570  return $options;
571  }
572 
581  public static function listDropDownOptionsOoui( $options ) {
582  $optionsOoui = [];
583 
584  foreach ( $options as $text => $value ) {
585  if ( is_array( $value ) ) {
586  $optionsOoui[] = [ 'optgroup' => (string)$text ];
587  foreach ( $value as $text2 => $value2 ) {
588  $optionsOoui[] = [ 'data' => (string)$value2, 'label' => (string)$text2 ];
589  }
590  } else {
591  $optionsOoui[] = [ 'data' => (string)$value, 'label' => (string)$text ];
592  }
593  }
594 
595  return $optionsOoui;
596  }
597 
609  public static function fieldset( $legend = false, $content = false, $attribs = [] ) {
610  $s = self::openElement( 'fieldset', $attribs ) . "\n";
611 
612  if ( $legend ) {
613  $s .= self::element( 'legend', null, $legend ) . "\n";
614  }
615 
616  if ( $content !== false ) {
617  $s .= $content . "\n";
618  $s .= self::closeElement( 'fieldset' ) . "\n";
619  }
620 
621  return $s;
622  }
623 
635  public static function textarea( $name, $content, $cols = 40, $rows = 5, $attribs = [] ) {
636  return self::element( 'textarea',
638  [
639  'name' => $name,
640  'id' => $name,
641  'cols' => $cols,
642  'rows' => $rows
643  ] + $attribs
644  ),
645  $content, false );
646  }
647 
659  public static function encodeJsVar( $value, $pretty = false ) {
660  if ( $value instanceof XmlJsCode ) {
661  return $value->value;
662  }
663  return FormatJson::encode( $value, $pretty, FormatJson::UTF8_OK );
664  }
665 
677  public static function encodeJsCall( $name, $args, $pretty = false ) {
678  foreach ( $args as &$arg ) {
679  $arg = self::encodeJsVar( $arg, $pretty );
680  if ( $arg === false ) {
681  return false;
682  }
683  }
684 
685  return "$name(" . ( $pretty
686  ? ( ' ' . implode( ', ', $args ) . ' ' )
687  : implode( ',', $args )
688  ) . ");";
689  }
690 
702  private static function isWellFormed( $text ) {
703  $parser = xml_parser_create( "UTF-8" );
704 
705  # case folding violates XML standard, turn it off
706  xml_parser_set_option( $parser, XML_OPTION_CASE_FOLDING, false );
707 
708  if ( !xml_parse( $parser, $text, true ) ) {
709  // $err = xml_error_string( xml_get_error_code( $parser ) );
710  // $position = xml_get_current_byte_index( $parser );
711  // $fragment = $this->extractFragment( $html, $position );
712  // $this->mXmlError = "$err at byte $position:\n$fragment";
713  xml_parser_free( $parser );
714  return false;
715  }
716 
717  xml_parser_free( $parser );
718 
719  return true;
720  }
721 
730  public static function isWellFormedXmlFragment( $text ) {
731  $html =
733  '<html>' .
734  $text .
735  '</html>';
736 
737  return self::isWellFormed( $html );
738  }
739 
747  public static function escapeTagsOnly( $in ) {
748  return str_replace(
749  [ '"', '>', '<' ],
750  [ '&quot;', '&gt;', '&lt;' ],
751  $in );
752  }
753 
765  public static function buildForm( $fields, $submitLabel = null, $submitAttribs = [] ) {
766  $form = '';
767  $form .= "<table><tbody>";
768 
769  foreach ( $fields as $labelmsg => $input ) {
770  $id = "mw-$labelmsg";
771  $form .= self::openElement( 'tr', [ 'id' => $id ] );
772 
773  // TODO use a <label> here for accessibility purposes - will need
774  // to either not use a table to build the form, or find the ID of
775  // the input somehow.
776 
777  $form .= self::tags( 'td', [ 'class' => 'mw-label' ], wfMessage( $labelmsg )->parse() );
778  $form .= self::openElement( 'td', [ 'class' => 'mw-input' ] )
779  . $input . self::closeElement( 'td' );
780  $form .= self::closeElement( 'tr' );
781  }
782 
783  if ( $submitLabel ) {
784  $form .= self::openElement( 'tr' );
785  $form .= self::tags( 'td', [], '' );
786  $form .= self::openElement( 'td', [ 'class' => 'mw-submit' ] )
787  . self::submitButton( wfMessage( $submitLabel )->text(), $submitAttribs )
788  . self::closeElement( 'td' );
789  $form .= self::closeElement( 'tr' );
790  }
791 
792  $form .= "</tbody></table>";
793 
794  return $form;
795  }
796 
804  public static function buildTable( $rows, $attribs = [], $headers = null ) {
805  $s = self::openElement( 'table', $attribs );
806 
807  if ( is_array( $headers ) ) {
808  $s .= self::openElement( 'thead', $attribs );
809 
810  foreach ( $headers as $id => $header ) {
811  $attribs = [];
812 
813  if ( is_string( $id ) ) {
814  $attribs['id'] = $id;
815  }
816 
817  $s .= self::element( 'th', $attribs, $header );
818  }
819  $s .= self::closeElement( 'thead' );
820  }
821 
822  foreach ( $rows as $id => $row ) {
823  $attribs = [];
824 
825  if ( is_string( $id ) ) {
826  $attribs['id'] = $id;
827  }
828 
829  $s .= self::buildTableRow( $attribs, $row );
830  }
831 
832  $s .= self::closeElement( 'table' );
833 
834  return $s;
835  }
836 
843  public static function buildTableRow( $attribs, $cells ) {
844  $s = self::openElement( 'tr', $attribs );
845 
846  foreach ( $cells as $id => $cell ) {
847  $attribs = [];
848 
849  if ( is_string( $id ) ) {
850  $attribs['id'] = $id;
851  }
852 
853  $s .= self::element( 'td', $attribs, $cell );
854  }
855 
856  $s .= self::closeElement( 'tr' );
857 
858  return $s;
859  }
860 }
static fetchLanguageNames( $inLanguage=self::AS_AUTONYMS, $include='mw')
Get an array of language names, indexed by code.
Definition: Language.php:814
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:231
static dateMenu( $year, $month)
Definition: Xml.php:167
The Message class provides methods which fulfil two basic services:
Definition: Message.php:162
static expandAttributes( $attribs)
Given an array of (&#39;attributename&#39; => &#39;value&#39;), it generates the code to set the XML attributes : att...
Definition: Xml.php:67
static attrib( $name, $present=true)
Internal function for use in checkboxes and radio buttons and such.
Definition: Xml.php:312
static option( $text, $value=null, $selected=false, $attribs=[])
Convenience function to build an HTML drop-down list item.
Definition: Xml.php:484
Class for generating HTML <select> or <datalist> elements.
Definition: XmlSelect.php:26
static input( $name, $size=false, $value=false, $attribs=[])
Convenience function to build an HTML text input field.
Definition: Xml.php:274
static encodeJsVar( $value, $pretty=false)
Encode a variable of arbitrary type to JavaScript.
Definition: Xml.php:659
static encode( $value, $pretty=false, $escaping=0)
Returns the JSON representation of a value.
Definition: FormatJson.php:115
static hackDocType()
Hack up a private DOCTYPE with HTML&#39;s standard entity declarations.
Definition: Sanitizer.php:2066
static elementClean( $element, $attribs=[], $contents='')
Format an XML element as with self::element(), but run text through the content language&#39;s normalize(...
Definition: Xml.php:90
static wrapClass( $text, $class, $tag='span', $attribs=[])
Shortcut to make a specific element with a class attribute.
Definition: Xml.php:262
static inputLabelSep( $label, $name, $id, $size=false, $value=false, $attribs=[])
Same as Xml::inputLabel() but return input and label in an array.
Definition: Xml.php:399
if( $line===false) $args
Definition: cdb.php:64
static buildTableRow( $attribs, $cells)
Build a row for a table.
Definition: Xml.php:843
const UTF8_OK
Skip escaping most characters above U+007F for readability and compactness.
Definition: FormatJson.php:34
static getInstance( $ts=false)
Get a timestamp instance in GMT.
Definition: MWTimestamp.php:39
$wgLanguageCode
Site language code.
static span( $text, $class, $attribs=[])
Shortcut to make a span element.
Definition: Xml.php:250
static getTextInputAttributes(array $attrs)
Modifies a set of attributes meant for text input elements and apply a set of default attributes...
Definition: Html.php:137
static languageSelector( $selected, $customisedOnly=true, $inLanguage=null, $overrideAttrs=[], Message $msg=null)
Construct a language selector appropriate for use in a form or preferences.
Definition: Xml.php:204
static monthSelector( $selected='', $allmonths=null, $id='month')
Create a date selector.
Definition: Xml.php:143
static password( $name, $size=false, $value=false, $attribs=[])
Convenience function to build an HTML password input field.
Definition: Xml.php:297
$wgLang
Definition: Setup.php:856
static openElement( $element, $attribs=null)
This opens an XML element.
Definition: Xml.php:108
static encodeJsCall( $name, $args, $pretty=false)
Create a call to a JavaScript function.
Definition: Xml.php:677
static escapeTagsOnly( $in)
Replace " > and < with their respective HTML entities ( ", >, <)
Definition: Xml.php:747
static fieldset( $legend=false, $content=false, $attribs=[])
Shortcut for creating fieldsets.
Definition: Xml.php:609
static listDropDownOptions( $list, $params=[])
Build options for a drop-down box from a textual list.
Definition: Xml.php:539
static submitButton( $value, $attribs=[])
Convenience function to build an HTML submit button When $wgUseMediaWikiUIEverywhere is true it will ...
Definition: Xml.php:459
A wrapper class which causes Xml::encodeJsVar() and Xml::encodeJsCall() to interpret a given string a...
Definition: XmlJsCode.php:40
static isWellFormed( $text)
Check if a string is well-formed XML.
Definition: Xml.php:702
static tags( $element, $attribs, $contents)
Same as Xml::element(), but does not escape contents.
Definition: Xml.php:130
$wgUseMediaWikiUIEverywhere
Temporary variable that applies MediaWiki UI wherever it can be supported.
$header
static input( $name, $value='', $type='text', array $attribs=[])
Convenience function to produce an "<input>" element.
Definition: Html.php:667
static label( $label, $id, $attribs=[])
Convenience function to build an HTML form label.
Definition: Xml.php:358
static radioLabel( $label, $name, $value, $id, $checked=false, $attribs=[])
Convenience function to build an HTML radio button with a label.
Definition: Xml.php:444
static isWellFormedXmlFragment( $text)
Check if a string is a well-formed XML fragment.
Definition: Xml.php:730
static closeElement( $element)
Shortcut to close an XML element.
Definition: Xml.php:117
static textarea( $name, $content, $cols=40, $rows=5, $attribs=[])
Shortcut for creating textareas.
Definition: Xml.php:635
static listDropDown( $name='', $list='', $other='', $selected='', $class='', $tabindex=null)
Build a drop-down box from a textual list.
Definition: Xml.php:508
static encodeAttribute( $text)
Encode an attribute value for HTML output.
Definition: Sanitizer.php:1156
static element( $element, $attribs=null, $contents='', $allowShortTag=true)
Format an XML element with given attributes and, optionally, text content.
Definition: Xml.php:41
static buildForm( $fields, $submitLabel=null, $submitAttribs=[])
Generate a form (without the opening form element).
Definition: Xml.php:765
static inputLabel( $label, $name, $id, $size=false, $value=false, $attribs=[])
Convenience function to build an HTML text input field with a label.
Definition: Xml.php:380
$content
Definition: router.php:78
static checkLabel( $label, $name, $id, $checked=false, $attribs=[])
Convenience function to build an HTML checkbox with a label.
Definition: Xml.php:419
wfMessage( $key,... $params)
This is the function for getting translated interface messages.
static radio( $name, $value, $checked=false, $attribs=[])
Convenience function to build an HTML radio button.
Definition: Xml.php:341
static check( $name, $checked=false, $attribs=[])
Convenience function to build an HTML checkbox.
Definition: Xml.php:323
switch( $options['output']) $languages
Definition: transstat.php:76
static listDropDownOptionsOoui( $options)
Convert options for a drop-down box into a format accepted by OOUI\DropdownInputWidget etc...
Definition: Xml.php:581
static buildTable( $rows, $attribs=[], $headers=null)
Build a table of data.
Definition: Xml.php:804