019e0785f9dbab8fc06bf51734b99a5e00a6fd15
3 * Collection of methods to generate HTML content
5 * Copyright © 2009 Aryeh Gregor
6 * https://www.mediawiki.org/
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21 * http://www.gnu.org/copyleft/gpl.html
27 * This class is a collection of static functions that serve two purposes:
29 * 1) Implement any algorithms specified by HTML5, or other HTML
30 * specifications, in a convenient and self-contained way.
32 * 2) Allow HTML elements to be conveniently and safely generated, like the
33 * current Xml class but a) less confused (Xml supports HTML-specific things,
34 * but only sometimes!) and b) not necessarily confined to XML-compatible
37 * There are two important configuration options this class uses:
39 * $wgMimeType: If this is set to an xml MIME type then output should be
42 * This class is meant to be confined to utility functions that are called from
43 * trusted code paths. It does not do enforcement of policy like not allowing
49 // List of void elements from HTML5, section 8.1.2 as of 2016-09-19
50 private static $voidElements = [
68 // Boolean attributes, which may have the value omitted entirely. Manually
69 // collected from the HTML5 spec as of 2011-08-12.
70 private static $boolAttribs = [
102 * Modifies a set of attributes meant for button elements
103 * and apply a set of default attributes when $wgUseMediaWikiUIEverywhere enabled.
104 * @param array $attrs HTML attributes in an associative array
105 * @param string[] $modifiers classes to add to the button
106 * @see https://tools.wmflabs.org/styleguide/desktop/index.html for guidance on available modifiers
107 * @return array $attrs A modified attribute array
109 public static function buttonAttributes( array $attrs, array $modifiers = [] ) {
110 global $wgUseMediaWikiUIEverywhere;
111 if ( $wgUseMediaWikiUIEverywhere ) {
112 if ( isset( $attrs['class'] ) ) {
113 if ( is_array( $attrs['class'] ) ) {
114 $attrs['class'][] = 'mw-ui-button';
115 $attrs['class'] = array_merge( $attrs['class'], $modifiers );
116 // ensure compatibility with Xml
117 $attrs['class'] = implode( ' ', $attrs['class'] );
119 $attrs['class'] .= ' mw-ui-button ' . implode( ' ', $modifiers );
122 // ensure compatibility with Xml
123 $attrs['class'] = 'mw-ui-button ' . implode( ' ', $modifiers );
130 * Modifies a set of attributes meant for text input elements
131 * and apply a set of default attributes.
132 * Removes size attribute when $wgUseMediaWikiUIEverywhere enabled.
133 * @param array $attrs An attribute array.
134 * @return array $attrs A modified attribute array
136 public static function getTextInputAttributes( array $attrs ) {
137 global $wgUseMediaWikiUIEverywhere;
138 if ( $wgUseMediaWikiUIEverywhere ) {
139 if ( isset( $attrs['class'] ) ) {
140 if ( is_array( $attrs['class'] ) ) {
141 $attrs['class'][] = 'mw-ui-input';
143 $attrs['class'] .= ' mw-ui-input';
146 $attrs['class'] = 'mw-ui-input';
153 * Returns an HTML link element in a string styled as a button
154 * (when $wgUseMediaWikiUIEverywhere is enabled).
156 * @param string $contents The raw HTML contents of the element: *not*
158 * @param array $attrs Associative array of attributes, e.g., [
159 * 'href' => 'https://www.mediawiki.org/' ]. See expandAttributes() for
160 * further documentation.
161 * @param string[] $modifiers classes to add to the button
162 * @see https://tools.wmflabs.org/styleguide/desktop/index.html for guidance on available modifiers
163 * @return string Raw HTML
165 public static function linkButton( $contents, array $attrs, array $modifiers = [] ) {
166 return self
::element( 'a',
167 self
::buttonAttributes( $attrs, $modifiers ),
173 * Returns an HTML link element in a string styled as a button
174 * (when $wgUseMediaWikiUIEverywhere is enabled).
176 * @param string $contents The raw HTML contents of the element: *not*
178 * @param array $attrs Associative array of attributes, e.g., [
179 * 'href' => 'https://www.mediawiki.org/' ]. See expandAttributes() for
180 * further documentation.
181 * @param string[] $modifiers classes to add to the button
182 * @see https://tools.wmflabs.org/styleguide/desktop/index.html for guidance on available modifiers
183 * @return string Raw HTML
185 public static function submitButton( $contents, array $attrs, array $modifiers = [] ) {
186 $attrs['type'] = 'submit';
187 $attrs['value'] = $contents;
188 return self
::element( 'input', self
::buttonAttributes( $attrs, $modifiers ) );
192 * Returns an HTML element in a string. The major advantage here over
193 * manually typing out the HTML is that it will escape all attribute
196 * This is quite similar to Xml::tags(), but it implements some useful
197 * HTML-specific logic. For instance, there is no $allowShortTag
198 * parameter: the closing tag is magically omitted if $element has an empty
201 * @param string $element The element's name, e.g., 'a'
202 * @param array $attribs Associative array of attributes, e.g., [
203 * 'href' => 'https://www.mediawiki.org/' ]. See expandAttributes() for
204 * further documentation.
205 * @param string $contents The raw HTML contents of the element: *not*
207 * @return string Raw HTML
209 public static function rawElement( $element, $attribs = [], $contents = '' ) {
210 $start = self
::openElement( $element, $attribs );
211 if ( in_array( $element, self
::$voidElements ) ) {
213 return substr( $start, 0, -1 ) . '/>';
215 return "$start$contents" . self
::closeElement( $element );
220 * Identical to rawElement(), but HTML-escapes $contents (like
223 * @param string $element Name of the element, e.g., 'a'
224 * @param array $attribs Associative array of attributes, e.g., [
225 * 'href' => 'https://www.mediawiki.org/' ]. See expandAttributes() for
226 * further documentation.
227 * @param string $contents
231 public static function element( $element, $attribs = [], $contents = '' ) {
232 return self
::rawElement( $element, $attribs, strtr( $contents, [
233 // There's no point in escaping quotes, >, etc. in the contents of
241 * Identical to rawElement(), but has no third parameter and omits the end
242 * tag (and the self-closing '/' in XML mode for empty elements).
244 * @param string $element Name of the element, e.g., 'a'
245 * @param array $attribs Associative array of attributes, e.g., [
246 * 'href' => 'https://www.mediawiki.org/' ]. See expandAttributes() for
247 * further documentation.
251 public static function openElement( $element, $attribs = [] ) {
252 $attribs = (array)$attribs;
253 // This is not required in HTML5, but let's do it anyway, for
254 // consistency and better compression.
255 $element = strtolower( $element );
257 // Remove invalid input types
258 if ( $element == 'input' ) {
286 if ( isset( $attribs['type'] ) && !in_array( $attribs['type'], $validTypes ) ) {
287 unset( $attribs['type'] );
291 // According to standard the default type for <button> elements is "submit".
292 // Depending on compatibility mode IE might use "button", instead.
293 // We enforce the standard "submit".
294 if ( $element == 'button' && !isset( $attribs['type'] ) ) {
295 $attribs['type'] = 'submit';
298 return "<$element" . self
::expandAttributes(
299 self
::dropDefaults( $element, $attribs ) ) . '>';
303 * Returns "</$element>"
306 * @param string $element Name of the element, e.g., 'a'
307 * @return string A closing tag
309 public static function closeElement( $element ) {
310 $element = strtolower( $element );
312 return "</$element>";
316 * Given an element name and an associative array of element attributes,
317 * return an array that is functionally identical to the input array, but
318 * possibly smaller. In particular, attributes might be stripped if they
319 * are given their default values.
321 * This method is not guaranteed to remove all redundant attributes, only
322 * some common ones and some others selected arbitrarily at random. It
323 * only guarantees that the output array should be functionally identical
324 * to the input array (currently per the HTML 5 draft as of 2009-09-06).
326 * @param string $element Name of the element, e.g., 'a'
327 * @param array $attribs Associative array of attributes, e.g., [
328 * 'href' => 'https://www.mediawiki.org/' ]. See expandAttributes() for
329 * further documentation.
330 * @return array An array of attributes functionally identical to $attribs
332 private static function dropDefaults( $element, array $attribs ) {
333 // Whenever altering this array, please provide a covering test case
334 // in HtmlTest::provideElementsWithAttributesHavingDefaultValues
335 static $attribDefaults = [
336 'area' => [ 'shape' => 'rect' ],
338 'formaction' => 'GET',
339 'formenctype' => 'application/x-www-form-urlencoded',
347 'autocomplete' => 'on',
348 'enctype' => 'application/x-www-form-urlencoded',
351 'formaction' => 'GET',
354 'keygen' => [ 'keytype' => 'rsa' ],
355 'link' => [ 'media' => 'all' ],
356 'menu' => [ 'type' => 'list' ],
357 'script' => [ 'type' => 'text/javascript' ],
360 'type' => 'text/css',
362 'textarea' => [ 'wrap' => 'soft' ],
365 $element = strtolower( $element );
367 foreach ( $attribs as $attrib => $value ) {
368 $lcattrib = strtolower( $attrib );
369 if ( is_array( $value ) ) {
370 $value = implode( ' ', $value );
372 $value = strval( $value );
375 // Simple checks using $attribDefaults
376 if ( isset( $attribDefaults[$element][$lcattrib] )
377 && $attribDefaults[$element][$lcattrib] == $value
379 unset( $attribs[$attrib] );
382 if ( $lcattrib == 'class' && $value == '' ) {
383 unset( $attribs[$attrib] );
387 // More subtle checks
388 if ( $element === 'link'
389 && isset( $attribs['type'] ) && strval( $attribs['type'] ) == 'text/css'
391 unset( $attribs['type'] );
393 if ( $element === 'input' ) {
394 $type = isset( $attribs['type'] ) ?
$attribs['type'] : null;
395 $value = isset( $attribs['value'] ) ?
$attribs['value'] : null;
396 if ( $type === 'checkbox' ||
$type === 'radio' ) {
397 // The default value for checkboxes and radio buttons is 'on'
398 // not ''. By stripping value="" we break radio boxes that
399 // actually wants empty values.
400 if ( $value === 'on' ) {
401 unset( $attribs['value'] );
403 } elseif ( $type === 'submit' ) {
404 // The default value for submit appears to be "Submit" but
405 // let's not bother stripping out localized text that matches
408 // The default value for nearly every other field type is ''
409 // The 'range' and 'color' types use different defaults but
410 // stripping a value="" does not hurt them.
411 if ( $value === '' ) {
412 unset( $attribs['value'] );
416 if ( $element === 'select' && isset( $attribs['size'] ) ) {
417 if ( in_array( 'multiple', $attribs )
418 ||
( isset( $attribs['multiple'] ) && $attribs['multiple'] !== false )
421 if ( strval( $attribs['size'] ) == '4' ) {
422 unset( $attribs['size'] );
426 if ( strval( $attribs['size'] ) == '1' ) {
427 unset( $attribs['size'] );
436 * Given an associative array of element attributes, generate a string
437 * to stick after the element name in HTML output. Like [ 'href' =>
438 * 'https://www.mediawiki.org/' ] becomes something like
439 * ' href="https://www.mediawiki.org"'. Again, this is like
440 * Xml::expandAttributes(), but it implements some HTML-specific logic.
442 * Attributes that can contain space-separated lists ('class', 'accesskey' and 'rel') array
443 * values are allowed as well, which will automagically be normalized
444 * and converted to a space-separated string. In addition to a numerical
445 * array, the attribute value may also be an associative array. See the
446 * example below for how that works.
448 * @par Numerical array
450 * Html::element( 'em', [
451 * 'class' => [ 'foo', 'bar' ]
453 * // gives '<em class="foo bar"></em>'
456 * @par Associative array
458 * Html::element( 'em', [
459 * 'class' => [ 'foo', 'bar', 'foo' => false, 'quux' => true ]
461 * // gives '<em class="bar quux"></em>'
464 * @param array $attribs Associative array of attributes, e.g., [
465 * 'href' => 'https://www.mediawiki.org/' ]. Values will be HTML-escaped.
466 * A value of false or null means to omit the attribute. For boolean attributes,
467 * you can omit the key, e.g., [ 'checked' ] instead of
468 * [ 'checked' => 'checked' ] or such.
470 * @throws MWException If an attribute that doesn't allow lists is set to an array
471 * @return string HTML fragment that goes between element name and '>'
472 * (starting with a space if at least one attribute is output)
474 public static function expandAttributes( array $attribs ) {
476 foreach ( $attribs as $key => $value ) {
477 // Support intuitive [ 'checked' => true/false ] form
478 if ( $value === false ||
is_null( $value ) ) {
482 // For boolean attributes, support [ 'foo' ] instead of
483 // requiring [ 'foo' => 'meaningless' ].
484 if ( is_int( $key ) && in_array( strtolower( $value ), self
::$boolAttribs ) ) {
488 // Not technically required in HTML5 but we'd like consistency
489 // and better compression anyway.
490 $key = strtolower( $key );
492 // https://www.w3.org/TR/html401/index/attributes.html ("space-separated")
493 // https://www.w3.org/TR/html5/index.html#attributes-1 ("space-separated")
494 $spaceSeparatedListAttributes = [
495 'class', // html4, html5
496 'accesskey', // as of html5, multiple space-separated values allowed
497 // html4-spec doesn't document rel= as space-separated
498 // but has been used like that and is now documented as such
499 // in the html5-spec.
503 // Specific features for attributes that allow a list of space-separated values
504 if ( in_array( $key, $spaceSeparatedListAttributes ) ) {
505 // Apply some normalization and remove duplicates
507 // Convert into correct array. Array can contain space-separated
508 // values. Implode/explode to get those into the main array as well.
509 if ( is_array( $value ) ) {
510 // If input wasn't an array, we can skip this step
512 foreach ( $value as $k => $v ) {
513 if ( is_string( $v ) ) {
514 // String values should be normal `array( 'foo' )`
516 if ( !isset( $value[$v] ) ) {
517 // As a special case don't set 'foo' if a
518 // separate 'foo' => true/false exists in the array
519 // keys should be authoritative
523 // If the value is truthy but not a string this is likely
524 // an [ 'foo' => true ], falsy values don't add strings
528 $value = implode( ' ', $newValue );
530 $value = explode( ' ', $value );
532 // Normalize spacing by fixing up cases where people used
533 // more than 1 space and/or a trailing/leading space
534 $value = array_diff( $value, [ '', ' ' ] );
536 // Remove duplicates and create the string
537 $value = implode( ' ', array_unique( $value ) );
538 } elseif ( is_array( $value ) ) {
539 throw new MWException( "HTML attribute $key can not contain a list of values" );
544 if ( in_array( $key, self
::$boolAttribs ) ) {
545 $ret .= " $key=\"\"";
547 $ret .= " $key=$quote" . Sanitizer
::encodeAttribute( $value ) . $quote;
554 * Output a "<script>" tag with the given contents.
556 * @todo do some useful escaping as well, like if $contents contains
557 * literal "</script>" or (for XML) literal "]]>".
559 * @param string $contents JavaScript
560 * @param string $nonce Nonce for CSP header, from OutputPage::getCSPNonce()
561 * @return string Raw HTML
563 public static function inlineScript( $contents, $nonce = null ) {
565 if ( $nonce !== null ) {
566 $attrs['nonce'] = $nonce;
568 if ( ContentSecurityPolicy
::isEnabled( RequestContext
::getMain()->getConfig() ) ) {
569 wfWarn( "no nonce set on script. CSP will break it" );
573 if ( preg_match( '/[<&]/', $contents ) ) {
574 $contents = "/*<![CDATA[*/$contents/*]]>*/";
577 return self
::rawElement( 'script', $attrs, $contents );
581 * Output a "<script>" tag linking to the given URL, e.g.,
582 * "<script src=foo.js></script>".
585 * @param string $nonce Nonce for CSP header, from OutputPage::getCSPNonce()
586 * @return string Raw HTML
588 public static function linkedScript( $url, $nonce = null ) {
589 $attrs = [ 'src' => $url ];
590 if ( $nonce !== null ) {
591 $attrs['nonce'] = $nonce;
593 if ( ContentSecurityPolicy
::isEnabled( RequestContext
::getMain()->getConfig() ) ) {
594 wfWarn( "no nonce set on script. CSP will break it" );
598 return self
::element( 'script', $attrs );
602 * Output a "<style>" tag with the given contents for the given media type
603 * (if any). TODO: do some useful escaping as well, like if $contents
604 * contains literal "</style>" (admittedly unlikely).
606 * @param string $contents CSS
607 * @param string $media A media type string, like 'screen'
608 * @param array $attribs (since 1.31) Associative array of attributes, e.g., [
609 * 'href' => 'https://www.mediawiki.org/' ]. See expandAttributes() for
610 * further documentation.
611 * @return string Raw HTML
613 public static function inlineStyle( $contents, $media = 'all', $attribs = [] ) {
614 // Don't escape '>' since that is used
615 // as direct child selector.
616 // Remember, in css, there is no "x" for hexadecimal escapes, and
617 // the space immediately after an escape sequence is swallowed.
618 $contents = strtr( $contents, [
620 // CDATA end tag for good measure, but the main security
621 // is from escaping the '<'.
622 ']]>' => '\5D\5D\3E '
625 if ( preg_match( '/[<&]/', $contents ) ) {
626 $contents = "/*<![CDATA[*/$contents/*]]>*/";
629 return self
::rawElement( 'style', [
631 ] +
$attribs, $contents );
635 * Output a "<link rel=stylesheet>" linking to the given URL for the given
636 * media type (if any).
639 * @param string $media A media type string, like 'screen'
640 * @return string Raw HTML
642 public static function linkedStyle( $url, $media = 'all' ) {
643 return self
::element( 'link', [
644 'rel' => 'stylesheet',
651 * Convenience function to produce an "<input>" element. This supports the
652 * new HTML5 input types and attributes.
654 * @param string $name Name attribute
655 * @param string $value Value attribute
656 * @param string $type Type attribute
657 * @param array $attribs Associative array of miscellaneous extra
658 * attributes, passed to Html::element()
659 * @return string Raw HTML
661 public static function input( $name, $value = '', $type = 'text', array $attribs = [] ) {
662 $attribs['type'] = $type;
663 $attribs['value'] = $value;
664 $attribs['name'] = $name;
665 if ( in_array( $type, [ 'text', 'search', 'email', 'password', 'number' ] ) ) {
666 $attribs = self
::getTextInputAttributes( $attribs );
668 if ( in_array( $type, [ 'button', 'reset', 'submit' ] ) ) {
669 $attribs = self
::buttonAttributes( $attribs );
671 return self
::element( 'input', $attribs );
675 * Convenience function to produce a checkbox (input element with type=checkbox)
677 * @param string $name Name attribute
678 * @param bool $checked Whether the checkbox is checked or not
679 * @param array $attribs Array of additional attributes
680 * @return string Raw HTML
682 public static function check( $name, $checked = false, array $attribs = [] ) {
683 if ( isset( $attribs['value'] ) ) {
684 $value = $attribs['value'];
685 unset( $attribs['value'] );
691 $attribs[] = 'checked';
694 return self
::input( $name, $value, 'checkbox', $attribs );
698 * Return the HTML for a message box.
700 * @param string $html of contents of box
701 * @param string $className corresponding to box
702 * @param string $heading (optional)
703 * @return string of HTML representing a box.
705 private static function messageBox( $html, $className, $heading = '' ) {
707 $html = self
::element( 'h2', [], $heading ) . $html;
709 return self
::rawElement( 'div', [ 'class' => $className ], $html );
713 * Return a warning box.
715 * @param string $html of contents of box
716 * @return string of HTML representing a warning box.
718 public static function warningBox( $html ) {
719 return self
::messageBox( $html, 'warningbox' );
723 * Return an error box.
725 * @param string $html of contents of error box
726 * @param string $heading (optional)
727 * @return string of HTML representing an error box.
729 public static function errorBox( $html, $heading = '' ) {
730 return self
::messageBox( $html, 'errorbox', $heading );
734 * Return a success box.
736 * @param string $html of contents of box
737 * @return string of HTML representing a success box.
739 public static function successBox( $html ) {
740 return self
::messageBox( $html, 'successbox' );
744 * Convenience function to produce a radio button (input element with type=radio)
746 * @param string $name Name attribute
747 * @param bool $checked Whether the radio button is checked or not
748 * @param array $attribs Array of additional attributes
749 * @return string Raw HTML
751 public static function radio( $name, $checked = false, array $attribs = [] ) {
752 if ( isset( $attribs['value'] ) ) {
753 $value = $attribs['value'];
754 unset( $attribs['value'] );
760 $attribs[] = 'checked';
763 return self
::input( $name, $value, 'radio', $attribs );
767 * Convenience function for generating a label for inputs.
769 * @param string $label Contents of the label
770 * @param string $id ID of the element being labeled
771 * @param array $attribs Additional attributes
772 * @return string Raw HTML
774 public static function label( $label, $id, array $attribs = [] ) {
778 return self
::element( 'label', $attribs, $label );
782 * Convenience function to produce an input element with type=hidden
784 * @param string $name Name attribute
785 * @param string $value Value attribute
786 * @param array $attribs Associative array of miscellaneous extra
787 * attributes, passed to Html::element()
788 * @return string Raw HTML
790 public static function hidden( $name, $value, array $attribs = [] ) {
791 return self
::input( $name, $value, 'hidden', $attribs );
795 * Convenience function to produce a <textarea> element.
797 * This supports leaving out the cols= and rows= which Xml requires and are
798 * required by HTML4/XHTML but not required by HTML5.
800 * @param string $name Name attribute
801 * @param string $value Value attribute
802 * @param array $attribs Associative array of miscellaneous extra
803 * attributes, passed to Html::element()
804 * @return string Raw HTML
806 public static function textarea( $name, $value = '', array $attribs = [] ) {
807 $attribs['name'] = $name;
809 if ( substr( $value, 0, 1 ) == "\n" ) {
810 // Workaround for T14130: browsers eat the initial newline
811 // assuming that it's just for show, but they do keep the later
812 // newlines, which we may want to preserve during editing.
813 // Prepending a single newline
814 $spacedValue = "\n" . $value;
816 $spacedValue = $value;
818 return self
::element( 'textarea', self
::getTextInputAttributes( $attribs ), $spacedValue );
822 * Helper for Html::namespaceSelector().
823 * @param array $params See Html::namespaceSelector()
826 public static function namespaceSelectorOptions( array $params = [] ) {
831 if ( !isset( $params['exclude'] ) ||
!is_array( $params['exclude'] ) ) {
832 $params['exclude'] = [];
835 if ( isset( $params['all'] ) ) {
836 // add an option that would let the user select all namespaces.
837 // Value is provided by user, the name shown is localized for the user.
838 $options[$params['all']] = wfMessage( 'namespacesall' )->text();
840 // Add all namespaces as options (in the content language)
841 $options +
= $wgContLang->getFormattedNamespaces();
844 // Filter out namespaces below 0 and massage labels
845 foreach ( $options as $nsId => $nsName ) {
846 if ( $nsId < NS_MAIN ||
in_array( $nsId, $params['exclude'] ) ) {
849 if ( $nsId === NS_MAIN
) {
850 // For other namespaces use the namespace prefix as label, but for
851 // main we don't use "" but the user message describing it (e.g. "(Main)" or "(Article)")
852 $nsName = wfMessage( 'blanknamespace' )->text();
853 } elseif ( is_int( $nsId ) ) {
854 $nsName = $wgContLang->convertNamespace( $nsId );
856 $optionsOut[$nsId] = $nsName;
863 * Build a drop-down box for selecting a namespace
865 * @param array $params Params to set.
866 * - selected: [optional] Id of namespace which should be pre-selected
867 * - all: [optional] Value of item for "all namespaces". If null or unset,
868 * no "<option>" is generated to select all namespaces.
869 * - label: text for label to add before the field.
870 * - exclude: [optional] Array of namespace ids to exclude.
871 * - disable: [optional] Array of namespace ids for which the option should
872 * be disabled in the selector.
873 * @param array $selectAttribs HTML attributes for the generated select element.
874 * - id: [optional], default: 'namespace'.
875 * - name: [optional], default: 'namespace'.
876 * @return string HTML code to select a namespace.
878 public static function namespaceSelector( array $params = [],
879 array $selectAttribs = []
881 ksort( $selectAttribs );
883 // Is a namespace selected?
884 if ( isset( $params['selected'] ) ) {
885 // If string only contains digits, convert to clean int. Selected could also
886 // be "all" or "" etc. which needs to be left untouched.
887 // PHP is_numeric() has issues with large strings, PHP ctype_digit has other issues
888 // and returns false for already clean ints. Use regex instead..
889 if ( preg_match( '/^\d+$/', $params['selected'] ) ) {
890 $params['selected'] = intval( $params['selected'] );
892 // else: leaves it untouched for later processing
894 $params['selected'] = '';
897 if ( !isset( $params['disable'] ) ||
!is_array( $params['disable'] ) ) {
898 $params['disable'] = [];
901 // Associative array between option-values and option-labels
902 $options = self
::namespaceSelectorOptions( $params );
904 // Convert $options to HTML
906 foreach ( $options as $nsId => $nsName ) {
907 $optionsHtml[] = self
::element(
909 'disabled' => in_array( $nsId, $params['disable'] ),
911 'selected' => $nsId === $params['selected'],
916 if ( !array_key_exists( 'id', $selectAttribs ) ) {
917 $selectAttribs['id'] = 'namespace';
920 if ( !array_key_exists( 'name', $selectAttribs ) ) {
921 $selectAttribs['name'] = 'namespace';
925 if ( isset( $params['label'] ) ) {
926 $ret .= self
::element(
928 'for' => isset( $selectAttribs['id'] ) ?
$selectAttribs['id'] : null,
933 // Wrap options in a <select>
934 $ret .= self
::openElement( 'select', $selectAttribs )
936 . implode( "\n", $optionsHtml )
938 . self
::closeElement( 'select' );
944 * Constructs the opening html-tag with necessary doctypes depending on
947 * @param array $attribs Associative array of miscellaneous extra
948 * attributes, passed to Html::element() of html tag.
949 * @return string Raw HTML
951 public static function htmlHeader( array $attribs = [] ) {
954 global $wgHtml5Version, $wgMimeType, $wgXhtmlNamespaces;
956 $isXHTML = self
::isXmlMimeType( $wgMimeType );
958 if ( $isXHTML ) { // XHTML5
959 // XML MIME-typed markup should have an xml header.
960 // However a DOCTYPE is not needed.
961 $ret .= "<?xml version=\"1.0\" encoding=\"UTF-8\" ?" . ">\n";
963 // Add the standard xmlns
964 $attribs['xmlns'] = 'http://www.w3.org/1999/xhtml';
966 // And support custom namespaces
967 foreach ( $wgXhtmlNamespaces as $tag => $ns ) {
968 $attribs["xmlns:$tag"] = $ns;
972 $ret .= "<!DOCTYPE html>\n";
975 if ( $wgHtml5Version ) {
976 $attribs['version'] = $wgHtml5Version;
979 $ret .= self
::openElement( 'html', $attribs );
985 * Determines if the given MIME type is xml.
987 * @param string $mimetype MIME type
990 public static function isXmlMimeType( $mimetype ) {
991 # https://html.spec.whatwg.org/multipage/infrastructure.html#xml-mime-type
994 # * Any MIME type with a subtype ending in +xml (this implicitly includes application/xhtml+xml)
995 return (bool)preg_match( '!^(text|application)/xml$|^.+/.+\+xml$!', $mimetype );
999 * Get HTML for an info box with an icon.
1001 * @param string $text Wikitext, get this with wfMessage()->plain()
1002 * @param string $icon Path to icon file (used as 'src' attribute)
1003 * @param string $alt Alternate text for the icon
1004 * @param string $class Additional class name to add to the wrapper div
1008 static function infoBox( $text, $icon, $alt, $class = '' ) {
1009 $s = self
::openElement( 'div', [ 'class' => "mw-infobox $class" ] );
1011 $s .= self
::openElement( 'div', [ 'class' => 'mw-infobox-left' ] ) .
1012 self
::element( 'img',
1018 self
::closeElement( 'div' );
1020 $s .= self
::openElement( 'div', [ 'class' => 'mw-infobox-right' ] ) .
1022 self
::closeElement( 'div' );
1023 $s .= self
::element( 'div', [ 'style' => 'clear: left;' ], ' ' );
1025 $s .= self
::closeElement( 'div' );
1027 $s .= self
::element( 'div', [ 'style' => 'clear: left;' ], ' ' );
1033 * Generate a srcset attribute value.
1035 * Generates a srcset attribute value from an array mapping pixel densities
1036 * to URLs. A trailing 'x' in pixel density values is optional.
1038 * @note srcset width and height values are not supported.
1040 * @see https://html.spec.whatwg.org/#attr-img-srcset
1045 * '1x' => 'standard.jpeg',
1046 * '1.5x' => 'large.jpeg',
1047 * '3x' => 'extra-large.jpeg',
1049 * // gives 'standard.jpeg 1x, large.jpeg 1.5x, extra-large.jpeg 2x'
1052 * @param string[] $urls
1055 static function srcSet( array $urls ) {
1057 foreach ( $urls as $density => $url ) {
1058 // Cast density to float to strip 'x', then back to string to serve
1060 $density = (string)(float)$density;
1061 $candidates[$density] = $url;
1064 // Remove duplicates that are the same as a smaller value
1065 ksort( $candidates, SORT_NUMERIC
);
1066 $candidates = array_unique( $candidates );
1068 // Append density info to the url
1069 foreach ( $candidates as $density => $url ) {
1070 $candidates[$density] = $url . ' ' . $density . 'x';
1073 return implode( ", ", $candidates );