3 * Methods to generate XML.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
24 * Module of static functions for generating XML
28 * Format an XML element with given attributes and, optionally, text content.
29 * Element and attribute names are assumed to be ready for literal inclusion.
30 * Strings are assumed to not contain XML-illegal characters; special
31 * characters (<, >, &) are escaped but illegals are not touched.
33 * @param string $element Element name
34 * @param array $attribs Name=>value pairs. Values will be escaped.
35 * @param string $contents Null to make an open tag only; '' for a contentless closed tag (default)
36 * @param bool $allowShortTag Whether '' in $contents will result in a contentless closed tag
39 public static function element( $element, $attribs = null, $contents = '',
42 $out = '<' . $element;
43 if ( !is_null( $attribs ) ) {
44 $out .= self
::expandAttributes( $attribs );
46 if ( is_null( $contents ) ) {
49 if ( $allowShortTag && $contents === '' ) {
52 $out .= '>' . htmlspecialchars( $contents ) . "</$element>";
59 * Given an array of ('attributename' => 'value'), it generates the code
60 * to set the XML attributes : attributename="value".
61 * The values are passed to Sanitizer::encodeAttribute.
62 * Return null if no attributes given.
63 * @param array $attribs Array of attributes for an XML element
67 public static function expandAttributes( $attribs ) {
69 if ( is_null( $attribs ) ) {
71 } elseif ( is_array( $attribs ) ) {
72 foreach ( $attribs as $name => $val ) {
73 $out .= " {$name}=\"" . Sanitizer
::encodeAttribute( $val ) . '"';
77 throw new MWException( 'Expected attribute array, got something else in ' . __METHOD__
);
82 * Format an XML element as with self::element(), but run text through the
83 * $wgContLang->normalize() validator first to ensure that no invalid UTF-8
86 * @param string $element
87 * @param array $attribs Name=>value pairs. Values will be escaped.
88 * @param string $contents Null to make an open tag only; '' for a contentless closed tag (default)
91 public static function elementClean( $element, $attribs = array(), $contents = '' ) {
94 $attribs = array_map( array( 'UtfNormal', 'cleanUp' ), $attribs );
97 wfProfileIn( __METHOD__
. '-norm' );
98 $contents = $wgContLang->normalize( $contents );
99 wfProfileOut( __METHOD__
. '-norm' );
101 return self
::element( $element, $attribs, $contents );
105 * This opens an XML element
107 * @param string $element Name of the element
108 * @param array $attribs Array of attributes, see Xml::expandAttributes()
111 public static function openElement( $element, $attribs = null ) {
112 return '<' . $element . self
::expandAttributes( $attribs ) . '>';
116 * Shortcut to close an XML element
117 * @param string $element Element name
120 public static function closeElement( $element ) {
121 return "</$element>";
125 * Same as Xml::element(), but does not escape contents. Handy when the
126 * content you have is already valid xml.
128 * @param string $element Element name
129 * @param array $attribs Array of attributes
130 * @param string $contents Content of the element
133 public static function tags( $element, $attribs = null, $contents ) {
134 return self
::openElement( $element, $attribs ) . $contents . "</$element>";
138 * Build a drop-down box for selecting a namespace
140 * @param string $selected Namespace which should be pre-selected
141 * @param string|null $all Value of an item denoting all namespaces, or null to omit
142 * @param string $element_name Value of the "name" attribute of the select tag
143 * @param string $label Optional label to add to the field
145 * @deprecated since 1.19
147 public static function namespaceSelector( $selected = '', $all = null,
148 $element_name = 'namespace', $label = null
150 wfDeprecated( __METHOD__
, '1.19' );
151 return Html
::namespaceSelector( array(
152 'selected' => $selected,
156 'name' => $element_name,
158 'class' => 'namespaceselector',
163 * Create a date selector
165 * @param string $selected The month which should be selected, default ''.
166 * @param string $allmonths Value of a special item denoting all month.
167 * Null to not include (default).
168 * @param string $id Element identifier
169 * @return string Html string containing the month selector
171 public static function monthSelector( $selected = '', $allmonths = null, $id = 'month' ) {
174 if ( is_null( $selected ) ) {
177 if ( !is_null( $allmonths ) ) {
178 $options[] = self
::option(
179 wfMessage( 'monthsall' )->text(),
181 $selected === $allmonths
184 for ( $i = 1; $i < 13; $i++
) {
185 $options[] = self
::option( $wgLang->getMonthName( $i ), $i, $selected === $i );
187 return self
::openElement( 'select', array(
190 'class' => 'mw-month-selector'
192 . implode( "\n", $options )
193 . self
::closeElement( 'select' );
199 * @return string Formatted HTML
201 public static function dateMenu( $year, $month ) {
202 # Offset overrides year/month selection
203 if ( $month && $month !== -1 ) {
204 $encMonth = intval( $month );
209 $encYear = intval( $year );
210 } elseif ( $encMonth ) {
211 $timestamp = MWTimestamp
::getInstance();
212 $thisMonth = intval( $timestamp->format( 'n' ) );
213 $thisYear = intval( $timestamp->format( 'Y' ) );
214 if ( intval( $encMonth ) > $thisMonth ) {
217 $encYear = $thisYear;
221 $inputAttribs = array( 'id' => 'year', 'maxlength' => 4, 'size' => 7 );
222 return self
::label( wfMessage( 'year' )->text(), 'year' ) . ' ' .
223 Html
::input( 'year', $encYear, 'number', $inputAttribs ) . ' ' .
224 self
::label( wfMessage( 'month' )->text(), 'month' ) . ' ' .
225 self
::monthSelector( $encMonth, -1 );
229 * Construct a language selector appropriate for use in a form or preferences
231 * @param string $selected The language code of the selected language
232 * @param bool $customisedOnly If true only languages which have some content are listed
233 * @param string $inLanguage The ISO code of the language to display the select list in (optional)
234 * @param array $overrideAttrs Override the attributes of the select tag (since 1.20)
235 * @param Message|null $msg Label message key (since 1.20)
236 * @return array Array containing 2 items: label HTML and select list HTML
238 public static function languageSelector( $selected, $customisedOnly = true,
239 $inLanguage = null, $overrideAttrs = array(), Message
$msg = null
241 global $wgLanguageCode;
243 $include = $customisedOnly ?
'mwfile' : 'mw';
244 $languages = Language
::fetchLanguageNames( $inLanguage, $include );
246 // Make sure the site language is in the list;
247 // a custom language code might not have a defined name...
248 if ( !array_key_exists( $wgLanguageCode, $languages ) ) {
249 $languages[$wgLanguageCode] = $wgLanguageCode;
255 * If a bogus value is set, default to the content language.
256 * Otherwise, no default is selected and the user ends up
257 * with Afrikaans since it's first in the list.
259 $selected = isset( $languages[$selected] ) ?
$selected : $wgLanguageCode;
261 foreach ( $languages as $code => $name ) {
262 $options .= Xml
::option( "$code - $name", $code, $code == $selected ) . "\n";
265 $attrs = array( 'id' => 'wpUserLanguage', 'name' => 'wpUserLanguage' );
266 $attrs = array_merge( $attrs, $overrideAttrs );
268 if ( $msg === null ) {
269 $msg = wfMessage( 'yourlanguage' );
272 Xml
::label( $msg->text(), $attrs['id'] ),
273 Xml
::tags( 'select', $attrs, $options )
279 * Shortcut to make a span element
280 * @param string $text Content of the element, will be escaped
281 * @param string $class Class name of the span element
282 * @param array $attribs Other attributes
285 public static function span( $text, $class, $attribs = array() ) {
286 return self
::element( 'span', array( 'class' => $class ) +
$attribs, $text );
290 * Shortcut to make a specific element with a class attribute
291 * @param string $text Content of the element, will be escaped
292 * @param string $class Class name of the span element
293 * @param string $tag Element name
294 * @param array $attribs Other attributes
297 public static function wrapClass( $text, $class, $tag = 'span', $attribs = array() ) {
298 return self
::tags( $tag, array( 'class' => $class ) +
$attribs, $text );
302 * Convenience function to build an HTML text input field
303 * @param string $name Value of the name attribute
304 * @param int $size Value of the size attribute
305 * @param mixed $value Value of the value attribute
306 * @param array $attribs Other attributes
307 * @return string HTML
309 public static function input( $name, $size = false, $value = false, $attribs = array() ) {
310 $attributes = array( 'name' => $name );
313 $attributes['size'] = $size;
316 if ( $value !== false ) { // maybe 0
317 $attributes['value'] = $value;
320 return self
::element( 'input',
321 Html
::getTextInputAttributes( $attributes +
$attribs ) );
325 * Convenience function to build an HTML password input field
326 * @param string $name Value of the name attribute
327 * @param int $size Value of the size attribute
328 * @param mixed $value Value of the value attribute
329 * @param array $attribs Other attributes
330 * @return string HTML
332 public static function password( $name, $size = false, $value = false,
335 return self
::input( $name, $size, $value,
336 array_merge( $attribs, array( 'type' => 'password' ) ) );
340 * Internal function for use in checkboxes and radio buttons and such.
342 * @param string $name
343 * @param bool $present
347 public static function attrib( $name, $present = true ) {
348 return $present ?
array( $name => $name ) : array();
352 * Convenience function to build an HTML checkbox
353 * @param string $name Value of the name attribute
354 * @param bool $checked Whether the checkbox is checked or not
355 * @param array $attribs Array other attributes
356 * @return string HTML
358 public static function check( $name, $checked = false, $attribs = array() ) {
359 return self
::element( 'input', array_merge(
362 'type' => 'checkbox',
364 self
::attrib( 'checked', $checked ),
369 * Convenience function to build an HTML radio button
370 * @param string $name Value of the name attribute
371 * @param string $value Value of the value attribute
372 * @param bool $checked Whether the checkbox is checked or not
373 * @param array $attribs Other attributes
374 * @return string HTML
376 public static function radio( $name, $value, $checked = false, $attribs = array() ) {
377 return self
::element( 'input', array(
380 'value' => $value ) + self
::attrib( 'checked', $checked ) +
$attribs );
384 * Convenience function to build an HTML form label
385 * @param string $label Text of the label
387 * @param array $attribs An attribute array. This will usually be
388 * the same array as is passed to the corresponding input element,
389 * so this function will cherry-pick appropriate attributes to
390 * apply to the label as well; only class and title are applied.
391 * @return string HTML
393 public static function label( $label, $id, $attribs = array() ) {
394 $a = array( 'for' => $id );
396 # FIXME avoid copy pasting below:
397 if ( isset( $attribs['class'] ) ) {
398 $a['class'] = $attribs['class'];
400 if ( isset( $attribs['title'] ) ) {
401 $a['title'] = $attribs['title'];
404 return self
::element( 'label', $a, $label );
408 * Convenience function to build an HTML text input field with a label
409 * @param string $label Text of the label
410 * @param string $name Value of the name attribute
411 * @param string $id Id of the input
412 * @param int|bool $size Value of the size attribute
413 * @param string|bool $value Value of the value attribute
414 * @param array $attribs Other attributes
415 * @return string HTML
417 public static function inputLabel( $label, $name, $id, $size = false,
418 $value = false, $attribs = array()
420 list( $label, $input ) = self
::inputLabelSep( $label, $name, $id, $size, $value, $attribs );
421 return $label . ' ' . $input;
425 * Same as Xml::inputLabel() but return input and label in an array
427 * @param string $label
428 * @param string $name
430 * @param int|bool $size
431 * @param string|bool $value
432 * @param array $attribs
436 public static function inputLabelSep( $label, $name, $id, $size = false,
437 $value = false, $attribs = array()
440 Xml
::label( $label, $id, $attribs ),
441 self
::input( $name, $size, $value, array( 'id' => $id ) +
$attribs )
446 * Convenience function to build an HTML checkbox with a label
448 * @param string $label
449 * @param string $name
451 * @param bool $checked
452 * @param array $attribs
454 * @return string HTML
456 public static function checkLabel( $label, $name, $id, $checked = false, $attribs = array() ) {
457 global $wgUseMediaWikiUIEverywhere;
458 $chkLabel = self
::check( $name, $checked, array( 'id' => $id ) +
$attribs ) .
460 self
::label( $label, $id, $attribs );
462 if ( $wgUseMediaWikiUIEverywhere ) {
463 $chkLabel = self
::openElement( 'div', array( 'class' => 'mw-ui-checkbox' ) ) .
464 $chkLabel . self
::closeElement( 'div' );
470 * Convenience function to build an HTML radio button with a label
472 * @param string $label
473 * @param string $name
474 * @param string $value
476 * @param bool $checked
477 * @param array $attribs
479 * @return string HTML
481 public static function radioLabel( $label, $name, $value, $id,
482 $checked = false, $attribs = array()
484 return self
::radio( $name, $value, $checked, array( 'id' => $id ) +
$attribs ) .
486 self
::label( $label, $id, $attribs );
490 * Convenience function to build an HTML submit button
491 * When $wgUseMediaWikiUIEverywhere is true it will default to a constructive button
492 * @param string $value Label text for the button
493 * @param array $attribs Optional custom attributes
494 * @return string HTML
496 public static function submitButton( $value, $attribs = array() ) {
497 global $wgUseMediaWikiUIEverywhere;
502 // Done conditionally for time being as it is possible
504 // might need to be mw-ui-destructive (e.g. delete a page)
505 if ( $wgUseMediaWikiUIEverywhere ) {
506 $baseAttrs['class'] = 'mw-ui-button mw-ui-constructive';
508 // Any custom attributes will take precendence of anything in baseAttrs e.g. override the class
509 $attribs = $attribs +
$baseAttrs;
510 return Html
::element( 'input', $attribs );
514 * Convenience function to build an HTML drop-down list item.
515 * @param string $text Text for this item. Will be HTML escaped
516 * @param string $value Form submission value; if empty, use text
517 * @param bool $selected If true, will be the default selected item
518 * @param array $attribs Optional additional HTML attributes
519 * @return string HTML
521 public static function option( $text, $value = null, $selected = false,
522 $attribs = array() ) {
523 if ( !is_null( $value ) ) {
524 $attribs['value'] = $value;
527 $attribs['selected'] = 'selected';
529 return Html
::element( 'option', $attribs, $text );
533 * Build a drop-down box from a textual list.
535 * @param string $name Name and id for the drop-down
536 * @param string $list Correctly formatted text (newline delimited) to be
537 * used to generate the options.
538 * @param string $other Text for the "Other reasons" option
539 * @param string $selected Option which should be pre-selected
540 * @param string $class CSS classes for the drop-down
541 * @param int $tabindex Value of the tabindex attribute
544 public static function listDropDown( $name = '', $list = '', $other = '',
545 $selected = '', $class = '', $tabindex = null
549 $options = self
::option( $other, 'other', $selected === 'other' );
551 foreach ( explode( "\n", $list ) as $option ) {
552 $value = trim( $option );
553 if ( $value == '' ) {
555 } elseif ( substr( $value, 0, 1 ) == '*' && substr( $value, 1, 1 ) != '*' ) {
556 // A new group is starting ...
557 $value = trim( substr( $value, 1 ) );
559 $options .= self
::closeElement( 'optgroup' );
561 $options .= self
::openElement( 'optgroup', array( 'label' => $value ) );
563 } elseif ( substr( $value, 0, 2 ) == '**' ) {
565 $value = trim( substr( $value, 2 ) );
566 $options .= self
::option( $value, $value, $selected === $value );
568 // groupless reason list
570 $options .= self
::closeElement( 'optgroup' );
572 $options .= self
::option( $value, $value, $selected === $value );
578 $options .= self
::closeElement( 'optgroup' );
584 $attribs['id'] = $name;
585 $attribs['name'] = $name;
589 $attribs['class'] = $class;
593 $attribs['tabindex'] = $tabindex;
596 return Xml
::openElement( 'select', $attribs )
600 . Xml
::closeElement( 'select' );
604 * Shortcut for creating fieldsets.
606 * @param string|bool $legend Legend of the fieldset. If evaluates to false,
607 * legend is not added.
608 * @param string $content Pre-escaped content for the fieldset. If false,
609 * only open fieldset is returned.
610 * @param array $attribs Any attributes to fieldset-element.
614 public static function fieldset( $legend = false, $content = false, $attribs = array() ) {
615 $s = Xml
::openElement( 'fieldset', $attribs ) . "\n";
618 $s .= Xml
::element( 'legend', null, $legend ) . "\n";
621 if ( $content !== false ) {
622 $s .= $content . "\n";
623 $s .= Xml
::closeElement( 'fieldset' ) . "\n";
630 * Shortcut for creating textareas.
632 * @param string $name The 'name' for the textarea
633 * @param string $content Content for the textarea
634 * @param int $cols The number of columns for the textarea
635 * @param int $rows The number of rows for the textarea
636 * @param array $attribs Any other attributes for the textarea
640 public static function textarea( $name, $content, $cols = 40, $rows = 5, $attribs = array() ) {
641 return self
::element( 'textarea',
642 Html
::getTextInputAttributes(
654 * Returns an escaped string suitable for inclusion in a string literal
655 * for JavaScript source code.
656 * Illegal control characters are assumed not to be present.
658 * @deprecated since 1.21; use Xml::encodeJsVar() or Xml::encodeJsCall() instead
659 * @param string $string String to escape
662 public static function escapeJsString( $string ) {
663 // See ECMA 262 section 7.8.4 for string literal format
671 # To avoid closing the element or CDATA section
675 # To avoid any complaints about bad entity refs
678 # Work around https://bugzilla.mozilla.org/show_bug.cgi?id=274152
679 # Encode certain Unicode formatting chars so affected
680 # versions of Gecko don't misinterpret our strings;
681 # this is a common problem with Farsi text.
682 "\xe2\x80\x8c" => "\\u200c", // ZERO WIDTH NON-JOINER
683 "\xe2\x80\x8d" => "\\u200d", // ZERO WIDTH JOINER
686 return strtr( $string, $pairs );
690 * Encode a variable of arbitrary type to JavaScript.
691 * If the value is an XmlJsCode object, pass through the object's value verbatim.
693 * @note Only use this function for generating JavaScript code. If generating output
694 * for a proper JSON parser, just call FormatJson::encode() directly.
696 * @param mixed $value The value being encoded. Can be any type except a resource.
697 * @param bool $pretty If true, add non-significant whitespace to improve readability.
698 * @return string|bool String if successful; false upon failure
700 public static function encodeJsVar( $value, $pretty = false ) {
701 if ( $value instanceof XmlJsCode
) {
702 return $value->value
;
704 return FormatJson
::encode( $value, $pretty, FormatJson
::UTF8_OK
);
708 * Create a call to a JavaScript function. The supplied arguments will be
709 * encoded using Xml::encodeJsVar().
712 * @param string $name The name of the function to call, or a JavaScript expression
713 * which evaluates to a function object which is called.
714 * @param array $args The arguments to pass to the function.
715 * @param bool $pretty If true, add non-significant whitespace to improve readability.
716 * @return string|bool String if successful; false upon failure
718 public static function encodeJsCall( $name, $args, $pretty = false ) {
719 foreach ( $args as &$arg ) {
720 $arg = Xml
::encodeJsVar( $arg, $pretty );
721 if ( $arg === false ) {
726 return "$name(" . ( $pretty
727 ?
( ' ' . implode( ', ', $args ) . ' ' )
728 : implode( ',', $args )
733 * Check if a string is well-formed XML.
734 * Must include the surrounding tag.
736 * @param string $text String to test.
739 * @todo Error position reporting return
741 public static function isWellFormed( $text ) {
742 $parser = xml_parser_create( "UTF-8" );
744 # case folding violates XML standard, turn it off
745 xml_parser_set_option( $parser, XML_OPTION_CASE_FOLDING
, false );
747 if ( !xml_parse( $parser, $text, true ) ) {
748 //$err = xml_error_string( xml_get_error_code( $parser ) );
749 //$position = xml_get_current_byte_index( $parser );
750 //$fragment = $this->extractFragment( $html, $position );
751 //$this->mXmlError = "$err at byte $position:\n$fragment";
752 xml_parser_free( $parser );
756 xml_parser_free( $parser );
762 * Check if a string is a well-formed XML fragment.
763 * Wraps fragment in an \<html\> bit and doctype, so it can be a fragment
764 * and can use HTML named entities.
766 * @param string $text
769 public static function isWellFormedXmlFragment( $text ) {
771 Sanitizer
::hackDocType() .
776 return Xml
::isWellFormed( $html );
780 * Replace " > and < with their respective HTML entities ( ",
783 * @param string $in Text that might contain HTML tags.
784 * @return string Escaped string
786 public static function escapeTagsOnly( $in ) {
788 array( '"', '>', '<' ),
789 array( '"', '>', '<' ),
794 * Generate a form (without the opening form element).
795 * Output optionally includes a submit button.
796 * @param array $fields Associative array, key is the name of a message that
797 * contains a description for the field, value is an HTML string
798 * containing the appropriate input.
799 * @param string $submitLabel The name of a message containing a label for
801 * @param array $submitAttribs The attributes to add to the submit button
802 * @return string HTML form.
804 public static function buildForm( $fields, $submitLabel = null, $submitAttribs = array() ) {
806 $form .= "<table><tbody>";
808 foreach ( $fields as $labelmsg => $input ) {
809 $id = "mw-$labelmsg";
810 $form .= Xml
::openElement( 'tr', array( 'id' => $id ) );
812 // TODO use a <label> here for accessibility purposes - will need
813 // to either not use a table to build the form, or find the ID of
814 // the input somehow.
816 $form .= Xml
::tags( 'td', array( 'class' => 'mw-label' ), wfMessage( $labelmsg )->parse() );
817 $form .= Xml
::openElement( 'td', array( 'class' => 'mw-input' ) )
818 . $input . Xml
::closeElement( 'td' );
819 $form .= Xml
::closeElement( 'tr' );
822 if ( $submitLabel ) {
823 $form .= Xml
::openElement( 'tr' );
824 $form .= Xml
::tags( 'td', array(), '' );
825 $form .= Xml
::openElement( 'td', array( 'class' => 'mw-submit' ) )
826 . Xml
::submitButton( wfMessage( $submitLabel )->text(), $submitAttribs )
827 . Xml
::closeElement( 'td' );
828 $form .= Xml
::closeElement( 'tr' );
831 $form .= "</tbody></table>";
837 * Build a table of data
838 * @param array $rows An array of arrays of strings, each to be a row in a table
839 * @param array $attribs An array of attributes to apply to the table tag [optional]
840 * @param array $headers An array of strings to use as table headers [optional]
843 public static function buildTable( $rows, $attribs = array(), $headers = null ) {
844 $s = Xml
::openElement( 'table', $attribs );
846 if ( is_array( $headers ) ) {
847 $s .= Xml
::openElement( 'thead', $attribs );
849 foreach ( $headers as $id => $header ) {
852 if ( is_string( $id ) ) {
853 $attribs['id'] = $id;
856 $s .= Xml
::element( 'th', $attribs, $header );
858 $s .= Xml
::closeElement( 'thead' );
861 foreach ( $rows as $id => $row ) {
864 if ( is_string( $id ) ) {
865 $attribs['id'] = $id;
868 $s .= Xml
::buildTableRow( $attribs, $row );
871 $s .= Xml
::closeElement( 'table' );
877 * Build a row for a table
878 * @param array $attribs An array of attributes to apply to the tr tag
879 * @param array $cells An array of strings to put in <td>
882 public static function buildTableRow( $attribs, $cells ) {
883 $s = Xml
::openElement( 'tr', $attribs );
885 foreach ( $cells as $id => $cell ) {
888 if ( is_string( $id ) ) {
889 $attribs['id'] = $id;
892 $s .= Xml
::element( 'td', $attribs, $cell );
895 $s .= Xml
::closeElement( 'tr' );
902 protected $options = array();
903 protected $default = false;
904 protected $attributes = array();
906 public function __construct( $name = false, $id = false, $default = false ) {
908 $this->setAttribute( 'name', $name );
912 $this->setAttribute( 'id', $id );
915 if ( $default !== false ) {
916 $this->default = $default;
921 * @param string $default
923 public function setDefault( $default ) {
924 $this->default = $default;
928 * @param string $name
929 * @param array $value
931 public function setAttribute( $name, $value ) {
932 $this->attributes
[$name] = $value;
936 * @param string $name
939 public function getAttribute( $name ) {
940 if ( isset( $this->attributes
[$name] ) ) {
941 return $this->attributes
[$name];
948 * @param string $name
951 public function addOption( $name, $value = false ) {
953 $value = $value !== false ?
$value : $name;
955 $this->options
[] = array( $name => $value );
959 * This accepts an array of form
961 * label => ( label => value, label => value )
963 * @param array $options
965 public function addOptions( $options ) {
966 $this->options
[] = $options;
970 * This accepts an array of form
972 * label => ( label => value, label => value )
974 * @param array $options
975 * @param bool $default
978 static function formatOptions( $options, $default = false ) {
981 foreach ( $options as $label => $value ) {
982 if ( is_array( $value ) ) {
983 $contents = self
::formatOptions( $value, $default );
984 $data .= Html
::rawElement( 'optgroup', array( 'label' => $label ), $contents ) . "\n";
986 $data .= Xml
::option( $label, $value, $value === $default ) . "\n";
996 public function getHTML() {
999 foreach ( $this->options
as $options ) {
1000 $contents .= self
::formatOptions( $options, $this->default );
1003 return Html
::rawElement( 'select', $this->attributes
, rtrim( $contents ) );
1008 * A wrapper class which causes Xml::encodeJsVar() and Xml::encodeJsCall() to
1009 * interpret a given string as being a JavaScript expression, instead of string
1014 * Xml::encodeJsVar( new XmlJsCode( 'a + b' ) );
1018 * @note As of 1.21, XmlJsCode objects cannot be nested inside objects or arrays. The sole
1019 * exception is the $args argument to Xml::encodeJsCall() because Xml::encodeJsVar() is
1020 * called for each individual element in that array.
1027 function __construct( $value ) {
1028 $this->value
= $value;