4 * Module of static functions for generating XML
9 * Format an XML element with given attributes and, optionally, text content.
10 * Element and attribute names are assumed to be ready for literal inclusion.
11 * Strings are assumed to not contain XML-illegal characters; special
12 * characters (<, >, &) are escaped but illegals are not touched.
14 * @param $element String: element name
15 * @param $attribs Array: Name=>value pairs. Values will be escaped.
16 * @param $contents String: NULL to make an open tag only; '' for a contentless closed tag (default)
17 * @param $allowShortTag Bool: whether '' in $contents will result in a contentless closed tag
20 public static function element( $element, $attribs = null, $contents = '', $allowShortTag = true ) {
21 $out = '<' . $element;
22 if( !is_null( $attribs ) ) {
23 $out .= self
::expandAttributes( $attribs );
25 if( is_null( $contents ) ) {
28 if( $allowShortTag && $contents === '' ) {
31 $out .= '>' . htmlspecialchars( $contents ) . "</$element>";
38 * Given an array of ('attributename' => 'value'), it generates the code
39 * to set the XML attributes : attributename="value".
40 * The values are passed to Sanitizer::encodeAttribute.
41 * Return null if no attributes given.
42 * @param $attribs Array of attributes for an XML element
44 public static function expandAttributes( $attribs ) {
46 if( is_null( $attribs ) ) {
48 } elseif( is_array( $attribs ) ) {
49 foreach( $attribs as $name => $val )
50 $out .= " {$name}=\"" . Sanitizer
::encodeAttribute( $val ) . '"';
53 throw new MWException( 'Expected attribute array, got something else in ' . __METHOD__
);
58 * Format an XML element as with self::element(), but run text through the
59 * $wgContLang->normalize() validator first to ensure that no invalid UTF-8
62 * @param $element String:
63 * @param $attribs Array: Name=>value pairs. Values will be escaped.
64 * @param $contents String: NULL to make an open tag only; '' for a contentless closed tag (default)
67 public static function elementClean( $element, $attribs = array(), $contents = '') {
70 $attribs = array_map( array( 'UtfNormal', 'cleanUp' ), $attribs );
73 wfProfileIn( __METHOD__
. '-norm' );
74 $contents = $wgContLang->normalize( $contents );
75 wfProfileOut( __METHOD__
. '-norm' );
77 return self
::element( $element, $attribs, $contents );
81 * This opens an XML element
83 * @param $element name of the element
84 * @param $attribs array of attributes, see Xml::expandAttributes()
87 public static function openElement( $element, $attribs = null ) {
88 return '<' . $element . self
::expandAttributes( $attribs ) . '>';
92 * Shortcut to close an XML element
93 * @param $element element name
96 public static function closeElement( $element ) { return "</$element>"; }
99 * Same as Xml::element(), but does not escape contents. Handy when the
100 * content you have is already valid xml.
102 * @param $element element name
103 * @param $attribs array of attributes
104 * @param $contents content of the element
107 public static function tags( $element, $attribs = null, $contents ) {
108 return self
::openElement( $element, $attribs ) . $contents . "</$element>";
112 * Build a drop-down box for selecting a namespace
114 * @param $selected Mixed: Namespace which should be pre-selected
115 * @param $all Mixed: Value of an item denoting all namespaces, or null to omit
116 * @param $element_name String: value of the "name" attribute of the select tag
117 * @param $label String: optional label to add to the field
120 public static function namespaceSelector( $selected = '', $all = null, $element_name = 'namespace', $label = null ) {
122 $namespaces = $wgContLang->getFormattedNamespaces();
125 // Godawful hack... we'll be frequently passed selected namespaces
126 // as strings since PHP is such a shithole.
127 // But we also don't want blanks and nulls and "all"s matching 0,
128 // so let's convert *just* string ints to clean ints.
129 if( preg_match( '/^\d+$/', $selected ) ) {
130 $selected = intval( $selected );
133 if( !is_null( $all ) )
134 $namespaces = array( $all => wfMsg( 'namespacesall' ) ) +
$namespaces;
135 foreach( $namespaces as $index => $name ) {
136 if( $index < NS_MAIN
)
139 $name = wfMsg( 'blanknamespace' );
140 $options[] = self
::option( $name, $index, $index === $selected );
143 $ret = Xml
::openElement( 'select', array( 'id' => 'namespace', 'name' => $element_name,
144 'class' => 'namespaceselector' ) )
146 . implode( "\n", $options )
148 . Xml
::closeElement( 'select' );
149 if ( !is_null( $label ) ) {
150 $ret = Xml
::label( $label, $element_name ) . ' ' . $ret;
156 * Create a date selector
158 * @param $selected Mixed: the month which should be selected, default ''
159 * @param $allmonths String: value of a special item denoting all month. Null to not include (default)
160 * @param $id String: Element identifier
161 * @return String: Html string containing the month selector
163 public static function monthSelector( $selected = '', $allmonths = null, $id = 'month' ) {
166 if( is_null( $selected ) )
168 if( !is_null( $allmonths ) )
169 $options[] = self
::option( wfMsg( 'monthsall' ), $allmonths, $selected === $allmonths );
170 for( $i = 1; $i < 13; $i++
)
171 $options[] = self
::option( $wgLang->getMonthName( $i ), $i, $selected === $i );
172 return self
::openElement( 'select', array( 'id' => $id, 'name' => 'month', 'class' => 'mw-month-selector' ) )
173 . implode( "\n", $options )
174 . self
::closeElement( 'select' );
178 * @param $year Integer
179 * @param $month Integer
180 * @return string Formatted HTML
182 public static function dateMenu( $year, $month ) {
183 # Offset overrides year/month selection
184 if( $month && $month !== -1 ) {
185 $encMonth = intval( $month );
190 $encYear = intval( $year );
191 } else if( $encMonth ) {
192 $thisMonth = intval( gmdate( 'n' ) );
193 $thisYear = intval( gmdate( 'Y' ) );
194 if( intval($encMonth) > $thisMonth ) {
197 $encYear = $thisYear;
201 return Xml
::label( wfMsg( 'year' ), 'year' ) . ' '.
202 Xml
::input( 'year', 4, $encYear, array('id' => 'year', 'maxlength' => 4) ) . ' '.
203 Xml
::label( wfMsg( 'month' ), 'month' ) . ' '.
204 Xml
::monthSelector( $encMonth, -1 );
209 * @param $selected The language code of the selected language
210 * @param $customisedOnly If true only languages which have some content are listed
211 * @return array of label and select
213 public static function languageSelector( $selected, $customisedOnly = true ) {
214 global $wgContLanguageCode;
216 * Make sure the site language is in the list; a custom language code
217 * might not have a defined name...
219 $languages = Language
::getLanguageNames( $customisedOnly );
220 if( !array_key_exists( $wgContLanguageCode, $languages ) ) {
221 $languages[$wgContLanguageCode] = $wgContLanguageCode;
226 * If a bogus value is set, default to the content language.
227 * Otherwise, no default is selected and the user ends up
228 * with an Afrikaans interface since it's first in the list.
230 $selected = isset( $languages[$selected] ) ?
$selected : $wgContLanguageCode;
232 foreach( $languages as $code => $name ) {
233 $options .= Xml
::option( "$code - $name", $code, ($code == $selected) ) . "\n";
237 Xml
::label( wfMsg('yourlanguage'), 'wpUserLanguage' ),
239 array( 'id' => 'wpUserLanguage', 'name' => 'wpUserLanguage' ),
247 * Shortcut to make a span element
248 * @param $text content of the element, will be escaped
249 * @param $class class name of the span element
250 * @param $attribs other attributes
253 public static function span( $text, $class, $attribs=array() ) {
254 return self
::element( 'span', array( 'class' => $class ) +
$attribs, $text );
258 * Shortcut to make a specific element with a class attribute
259 * @param $text content of the element, will be escaped
260 * @param $class class name of the span element
261 * @param $tag element name
262 * @param $attribs other attributes
265 public static function wrapClass( $text, $class, $tag='span', $attribs=array() ) {
266 return self
::tags( $tag, array( 'class' => $class ) +
$attribs, $text );
270 * Convenience function to build an HTML text input field
271 * @param $name value of the name attribute
272 * @param $size value of the size attribute
273 * @param $value value of the value attribute
274 * @param $attribs other attributes
275 * @return string HTML
277 public static function input( $name, $size=false, $value=false, $attribs=array() ) {
278 return self
::element( 'input', array(
281 'value' => $value ) +
$attribs );
285 * Convenience function to build an HTML password input field
286 * @param $name value of the name attribute
287 * @param $size value of the size attribute
288 * @param $value value of the value attribute
289 * @param $attribs other attributes
290 * @return string HTML
292 public static function password( $name, $size=false, $value=false, $attribs=array() ) {
293 return self
::input( $name, $size, $value, array_merge($attribs, array('type' => 'password')));
297 * Internal function for use in checkboxes and radio buttons and such.
300 public static function attrib( $name, $present = true ) {
301 return $present ?
array( $name => $name ) : array();
305 * Convenience function to build an HTML checkbox
306 * @param $name value of the name attribute
307 * @param $checked Whether the checkbox is checked or not
308 * @param $attribs other attributes
309 * @return string HTML
311 public static function check( $name, $checked=false, $attribs=array() ) {
312 return self
::element( 'input', array_merge(
315 'type' => 'checkbox',
317 self
::attrib( 'checked', $checked ),
322 * Convenience function to build an HTML radio button
323 * @param $name value of the name attribute
324 * @param $value value of the value attribute
325 * @param $checked Whether the checkbox is checked or not
326 * @param $attribs other attributes
327 * @return string HTML
329 public static function radio( $name, $value, $checked=false, $attribs=array() ) {
330 return self
::element( 'input', array(
333 'value' => $value ) + self
::attrib( 'checked', $checked ) +
$attribs );
337 * Convenience function to build an HTML form label
338 * @param $label text of the label
340 * @param $attribs Array, other attributes
341 * @return string HTML
343 public static function label( $label, $id, $attribs=array() ) {
344 $a = array( 'for' => $id );
345 if( isset( $attribs['class'] ) ){
346 $a['class'] = $attribs['class'];
348 return self
::element( 'label', $a, $label );
352 * Convenience function to build an HTML text input field with a label
353 * @param $label text of the label
354 * @param $name value of the name attribute
355 * @param $id id of the input
356 * @param $size value of the size attribute
357 * @param $value value of the value attribute
358 * @param $attribs other attributes
359 * @return string HTML
361 public static function inputLabel( $label, $name, $id, $size=false, $value=false, $attribs=array() ) {
362 list( $label, $input ) = self
::inputLabelSep( $label, $name, $id, $size, $value, $attribs );
363 return $label . ' ' . $input;
367 * Same as Xml::inputLabel() but return input and label in an array
369 public static function inputLabelSep( $label, $name, $id, $size=false, $value=false, $attribs=array() ) {
371 Xml
::label( $label, $id, $attribs ),
372 self
::input( $name, $size, $value, array( 'id' => $id ) +
$attribs )
377 * Convenience function to build an HTML checkbox with a label
378 * @return string HTML
380 public static function checkLabel( $label, $name, $id, $checked=false, $attribs=array() ) {
381 return self
::check( $name, $checked, array( 'id' => $id ) +
$attribs ) .
383 self
::label( $label, $id, $attribs );
387 * Convenience function to build an HTML radio button with a label
388 * @return string HTML
390 public static function radioLabel( $label, $name, $value, $id, $checked=false, $attribs=array() ) {
391 return self
::radio( $name, $value, $checked, array( 'id' => $id ) +
$attribs ) .
393 self
::label( $label, $id, $attribs );
397 * Convenience function to build an HTML submit button
398 * @param $value String: label text for the button
399 * @param $attribs Array: optional custom attributes
400 * @return string HTML
402 public static function submitButton( $value, $attribs=array() ) {
403 return Html
::element( 'input', array( 'type' => 'submit', 'value' => $value ) +
$attribs );
407 * @deprecated Synonymous to Html::hidden()
409 public static function hidden( $name, $value, $attribs = array() ) {
410 return Html
::hidden( $name, $value, $attribs );
414 * Convenience function to build an HTML drop-down list item.
415 * @param $text String: text for this item
416 * @param $value String: form submission value; if empty, use text
417 * @param $selected boolean: if true, will be the default selected item
418 * @param $attribs array: optional additional HTML attributes
419 * @return string HTML
421 public static function option( $text, $value=null, $selected=false,
423 if( !is_null( $value ) ) {
424 $attribs['value'] = $value;
427 $attribs['selected'] = 'selected';
429 return self
::element( 'option', $attribs, $text );
433 * Build a drop-down box from a textual list.
435 * @param $name Mixed: Name and id for the drop-down
436 * @param $class Mixed: CSS classes for the drop-down
437 * @param $other Mixed: Text for the "Other reasons" option
438 * @param $list Mixed: Correctly formatted text to be used to generate the options
439 * @param $selected Mixed: Option which should be pre-selected
440 * @param $tabindex Mixed: Value of the tabindex attribute
443 public static function listDropDown( $name= '', $list = '', $other = '', $selected = '', $class = '', $tabindex = Null ) {
447 $options = self
::option( $other, 'other', $selected === 'other' );
449 foreach ( explode( "\n", $list ) as $option) {
450 $value = trim( $option );
451 if ( $value == '' ) {
453 } elseif ( substr( $value, 0, 1) == '*' && substr( $value, 1, 1) != '*' ) {
454 // A new group is starting ...
455 $value = trim( substr( $value, 1 ) );
456 if( $optgroup ) $options .= self
::closeElement('optgroup');
457 $options .= self
::openElement( 'optgroup', array( 'label' => $value ) );
459 } elseif ( substr( $value, 0, 2) == '**' ) {
461 $value = trim( substr( $value, 2 ) );
462 $options .= self
::option( $value, $value, $selected === $value );
464 // groupless reason list
465 if( $optgroup ) $options .= self
::closeElement('optgroup');
466 $options .= self
::option( $value, $value, $selected === $value );
470 if( $optgroup ) $options .= self
::closeElement('optgroup');
474 $attribs['id'] = $name;
475 $attribs['name'] = $name;
478 $attribs['class'] = $class;
481 $attribs['tabindex'] = $tabindex;
483 return Xml
::openElement( 'select', $attribs )
487 . Xml
::closeElement( 'select' );
491 * Shortcut for creating fieldsets.
493 * @param $legend Legend of the fieldset. If evaluates to false, legend is not added.
494 * @param $content Pre-escaped content for the fieldset. If false, only open fieldset is returned.
495 * @param $attribs Any attributes to fieldset-element.
497 public static function fieldset( $legend = false, $content = false, $attribs = array() ) {
498 $s = Xml
::openElement( 'fieldset', $attribs ) . "\n";
500 $s .= Xml
::element( 'legend', null, $legend ) . "\n";
502 if ( $content !== false ) {
503 $s .= $content . "\n";
504 $s .= Xml
::closeElement( 'fieldset' ) . "\n";
511 * Shortcut for creating textareas.
513 * @param $name The 'name' for the textarea
514 * @param $content Content for the textarea
515 * @param $cols The number of columns for the textarea
516 * @param $rows The number of rows for the textarea
517 * @param $attribs Any other attributes for the textarea
519 public static function textarea( $name, $content, $cols = 40, $rows = 5, $attribs = array() ) {
520 return self
::element( 'textarea',
521 array( 'name' => $name,
530 * Returns an escaped string suitable for inclusion in a string literal
531 * for JavaScript source code.
532 * Illegal control characters are assumed not to be present.
534 * @param $string String to escape
537 public static function escapeJsString( $string ) {
538 // See ECMA 262 section 7.8.4 for string literal format
546 # To avoid closing the element or CDATA section
550 # To avoid any complaints about bad entity refs
553 # Work around https://bugzilla.mozilla.org/show_bug.cgi?id=274152
554 # Encode certain Unicode formatting chars so affected
555 # versions of Gecko don't misinterpret our strings;
556 # this is a common problem with Farsi text.
557 "\xe2\x80\x8c" => "\\u200c", // ZERO WIDTH NON-JOINER
558 "\xe2\x80\x8d" => "\\u200d", // ZERO WIDTH JOINER
560 return strtr( $string, $pairs );
564 * Encode a variable of unknown type to JavaScript.
565 * Arrays are converted to JS arrays, objects are converted to JS associative
566 * arrays (objects). So cast your PHP associative arrays to objects before
567 * passing them to here.
569 public static function encodeJsVar( $value ) {
570 if ( is_bool( $value ) ) {
571 $s = $value ?
'true' : 'false';
572 } elseif ( is_null( $value ) ) {
574 } elseif ( is_int( $value ) ) {
576 } elseif ( is_array( $value ) && // Make sure it's not associative.
577 array_keys($value) === range( 0, count($value) - 1 ) ||
581 foreach ( $value as $elt ) {
585 $s .= self
::encodeJsVar( $elt );
588 } elseif ( is_object( $value ) ||
is_array( $value ) ) {
589 // Objects and associative arrays
591 foreach ( (array)$value as $name => $elt ) {
595 $s .= '"' . self
::escapeJsString( $name ) . '": ' .
596 self
::encodeJsVar( $elt );
600 $s = '"' . self
::escapeJsString( $value ) . '"';
607 * Check if a string is well-formed XML.
608 * Must include the surrounding tag.
610 * @param $text String: string to test.
613 * @todo Error position reporting return
615 public static function isWellFormed( $text ) {
616 $parser = xml_parser_create( "UTF-8" );
618 # case folding violates XML standard, turn it off
619 xml_parser_set_option( $parser, XML_OPTION_CASE_FOLDING
, false );
621 if( !xml_parse( $parser, $text, true ) ) {
622 //$err = xml_error_string( xml_get_error_code( $parser ) );
623 //$position = xml_get_current_byte_index( $parser );
624 //$fragment = $this->extractFragment( $html, $position );
625 //$this->mXmlError = "$err at byte $position:\n$fragment";
626 xml_parser_free( $parser );
629 xml_parser_free( $parser );
634 * Check if a string is a well-formed XML fragment.
635 * Wraps fragment in an \<html\> bit and doctype, so it can be a fragment
636 * and can use HTML named entities.
638 * @param $text String:
641 public static function isWellFormedXmlFragment( $text ) {
643 Sanitizer
::hackDocType() .
647 return Xml
::isWellFormed( $html );
651 * Replace " > and < with their respective HTML entities ( ",
654 * @param $in String: text that might contain HTML tags.
655 * @return string Escaped string
657 public static function escapeTagsOnly( $in ) {
659 array( '"', '>', '<' ),
660 array( '"', '>', '<' ),
665 * Generate a form (without the opening form element).
666 * Output optionally includes a submit button.
667 * @param $fields Associative array, key is message corresponding to a description for the field (colon is in the message), value is appropriate input.
668 * @param $submitLabel A message containing a label for the submit button.
669 * @return string HTML form.
671 public static function buildForm( $fields, $submitLabel = null ) {
673 $form .= "<table><tbody>";
675 foreach( $fields as $labelmsg => $input ) {
676 $id = "mw-$labelmsg";
677 $form .= Xml
::openElement( 'tr', array( 'id' => $id ) );
678 $form .= Xml
::tags( 'td', array('class' => 'mw-label'), wfMsgExt( $labelmsg, array('parseinline') ) );
679 $form .= Xml
::openElement( 'td', array( 'class' => 'mw-input' ) ) . $input . Xml
::closeElement( 'td' );
680 $form .= Xml
::closeElement( 'tr' );
684 $form .= Xml
::openElement( 'tr' );
685 $form .= Xml
::tags( 'td', array(), '' );
686 $form .= Xml
::openElement( 'td', array( 'class' => 'mw-submit' ) ) . Xml
::submitButton( wfMsg( $submitLabel ) ) . Xml
::closeElement( 'td' );
687 $form .= Xml
::closeElement( 'tr' );
690 $form .= "</tbody></table>";
697 * Build a table of data
698 * @param $rows An array of arrays of strings, each to be a row in a table
699 * @param $attribs An array of attributes to apply to the table tag [optional]
700 * @param $headers An array of strings to use as table headers [optional]
703 public static function buildTable( $rows, $attribs = array(), $headers = null ) {
704 $s = Xml
::openElement( 'table', $attribs );
705 if ( is_array( $headers ) ) {
706 foreach( $headers as $id => $header ) {
708 if ( is_string( $id ) ) $attribs['id'] = $id;
709 $s .= Xml
::element( 'th', $attribs, $header );
712 foreach( $rows as $id => $row ) {
714 if ( is_string( $id ) ) $attribs['id'] = $id;
715 $s .= Xml
::buildTableRow( $attribs, $row );
717 $s .= Xml
::closeElement( 'table' );
722 * Build a row for a table
723 * @param $attribs An array of attributes to apply to the tr tag
724 * @param $cells An array of strings to put in <td>
727 public static function buildTableRow( $attribs, $cells ) {
728 $s = Xml
::openElement( 'tr', $attribs );
729 foreach( $cells as $id => $cell ) {
731 if ( is_string( $id ) ) $attribs['id'] = $id;
732 $s .= Xml
::element( 'td', $attribs, $cell );
734 $s .= Xml
::closeElement( 'tr' );
740 protected $options = array();
741 protected $default = false;
742 protected $attributes = array();
744 public function __construct( $name = false, $id = false, $default = false ) {
745 if ( $name ) $this->setAttribute( 'name', $name );
746 if ( $id ) $this->setAttribute( 'id', $id );
747 if ( $default !== false ) $this->default = $default;
750 public function setDefault( $default ) {
751 $this->default = $default;
754 public function setAttribute( $name, $value ) {
755 $this->attributes
[$name] = $value;
758 public function getAttribute( $name ) {
759 if ( isset($this->attributes
[$name]) ) {
760 return $this->attributes
[$name];
766 public function addOption( $name, $value = false ) {
768 $value = ($value !== false) ?
$value : $name;
769 $this->options
[] = Xml
::option( $name, $value, $value === $this->default );
772 // This accepts an array of form
774 // label => ( label => value, label => value )
775 public function addOptions( $options ) {
776 $this->options
[] = trim(self
::formatOptions( $options, $this->default ));
779 // This accepts an array of form
781 // label => ( label => value, label => value )
782 static function formatOptions( $options, $default = false ) {
784 foreach( $options as $label => $value ) {
785 if ( is_array( $value ) ) {
786 $contents = self
::formatOptions( $value, $default );
787 $data .= Xml
::tags( 'optgroup', array( 'label' => $label ), $contents ) . "\n";
789 $data .= Xml
::option( $label, $value, $value === $default ) . "\n";
796 public function getHTML() {
797 return Xml
::tags( 'select', $this->attributes
, implode( "\n", $this->options
) );