MediaWiki  REL1_31
Html.php
Go to the documentation of this file.
1 <?php
48 class Html {
49  // List of void elements from HTML5, section 8.1.2 as of 2016-09-19
50  private static $voidElements = [
51  'area',
52  'base',
53  'br',
54  'col',
55  'embed',
56  'hr',
57  'img',
58  'input',
59  'keygen',
60  'link',
61  'meta',
62  'param',
63  'source',
64  'track',
65  'wbr',
66  ];
67 
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 = [
71  'async',
72  'autofocus',
73  'autoplay',
74  'checked',
75  'controls',
76  'default',
77  'defer',
78  'disabled',
79  'formnovalidate',
80  'hidden',
81  'ismap',
82  'itemscope',
83  'loop',
84  'multiple',
85  'muted',
86  'novalidate',
87  'open',
88  'pubdate',
89  'readonly',
90  'required',
91  'reversed',
92  'scoped',
93  'seamless',
94  'selected',
95  'truespeed',
96  'typemustmatch',
97  // HTML5 Microdata
98  'itemscope',
99  ];
100 
109  public static function buttonAttributes( array $attrs, array $modifiers = [] ) {
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'] );
118  } else {
119  $attrs['class'] .= ' mw-ui-button ' . implode( ' ', $modifiers );
120  }
121  } else {
122  // ensure compatibility with Xml
123  $attrs['class'] = 'mw-ui-button ' . implode( ' ', $modifiers );
124  }
125  }
126  return $attrs;
127  }
128 
136  public static function getTextInputAttributes( array $attrs ) {
139  if ( isset( $attrs['class'] ) ) {
140  if ( is_array( $attrs['class'] ) ) {
141  $attrs['class'][] = 'mw-ui-input';
142  } else {
143  $attrs['class'] .= ' mw-ui-input';
144  }
145  } else {
146  $attrs['class'] = 'mw-ui-input';
147  }
148  }
149  return $attrs;
150  }
151 
165  public static function linkButton( $contents, array $attrs, array $modifiers = [] ) {
166  return self::element( 'a',
167  self::buttonAttributes( $attrs, $modifiers ),
168  $contents
169  );
170  }
171 
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 ) );
189  }
190 
209  public static function rawElement( $element, $attribs = [], $contents = '' ) {
210  $start = self::openElement( $element, $attribs );
211  if ( in_array( $element, self::$voidElements ) ) {
212  // Silly XML.
213  return substr( $start, 0, -1 ) . '/>';
214  } else {
215  return "$start$contents" . self::closeElement( $element );
216  }
217  }
218 
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
234  // elements.
235  '&' => '&amp;',
236  '<' => '&lt;'
237  ] ) );
238  }
239 
251  public static function openElement( $element, $attribs = [] ) {
253  // This is not required in HTML5, but let's do it anyway, for
254  // consistency and better compression.
255  $element = strtolower( $element );
256 
257  // Remove invalid input types
258  if ( $element == 'input' ) {
259  $validTypes = [
260  'hidden',
261  'text',
262  'password',
263  'checkbox',
264  'radio',
265  'file',
266  'submit',
267  'image',
268  'reset',
269  'button',
270 
271  // HTML input types
272  'datetime',
273  'datetime-local',
274  'date',
275  'month',
276  'time',
277  'week',
278  'number',
279  'range',
280  'email',
281  'url',
282  'search',
283  'tel',
284  'color',
285  ];
286  if ( isset( $attribs['type'] ) && !in_array( $attribs['type'], $validTypes ) ) {
287  unset( $attribs['type'] );
288  }
289  }
290 
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';
296  }
297 
298  return "<$element" . self::expandAttributes(
299  self::dropDefaults( $element, $attribs ) ) . '>';
300  }
301 
309  public static function closeElement( $element ) {
310  $element = strtolower( $element );
311 
312  return "</$element>";
313  }
314 
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' ],
337  'button' => [
338  'formaction' => 'GET',
339  'formenctype' => 'application/x-www-form-urlencoded',
340  ],
341  'canvas' => [
342  'height' => '150',
343  'width' => '300',
344  ],
345  'form' => [
346  'action' => 'GET',
347  'autocomplete' => 'on',
348  'enctype' => 'application/x-www-form-urlencoded',
349  ],
350  'input' => [
351  'formaction' => 'GET',
352  'type' => 'text',
353  ],
354  'keygen' => [ 'keytype' => 'rsa' ],
355  'link' => [ 'media' => 'all' ],
356  'menu' => [ 'type' => 'list' ],
357  'script' => [ 'type' => 'text/javascript' ],
358  'style' => [
359  'media' => 'all',
360  'type' => 'text/css',
361  ],
362  'textarea' => [ 'wrap' => 'soft' ],
363  ];
364 
365  $element = strtolower( $element );
366 
367  foreach ( $attribs as $attrib => $value ) {
368  $lcattrib = strtolower( $attrib );
369  if ( is_array( $value ) ) {
370  $value = implode( ' ', $value );
371  } else {
372  $value = strval( $value );
373  }
374 
375  // Simple checks using $attribDefaults
376  if ( isset( $attribDefaults[$element][$lcattrib] )
377  && $attribDefaults[$element][$lcattrib] == $value
378  ) {
379  unset( $attribs[$attrib] );
380  }
381 
382  if ( $lcattrib == 'class' && $value == '' ) {
383  unset( $attribs[$attrib] );
384  }
385  }
386 
387  // More subtle checks
388  if ( $element === 'link'
389  && isset( $attribs['type'] ) && strval( $attribs['type'] ) == 'text/css'
390  ) {
391  unset( $attribs['type'] );
392  }
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'] );
402  }
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
406  // that.
407  } else {
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'] );
413  }
414  }
415  }
416  if ( $element === 'select' && isset( $attribs['size'] ) ) {
417  if ( in_array( 'multiple', $attribs )
418  || ( isset( $attribs['multiple'] ) && $attribs['multiple'] !== false )
419  ) {
420  // A multi-select
421  if ( strval( $attribs['size'] ) == '4' ) {
422  unset( $attribs['size'] );
423  }
424  } else {
425  // Single select
426  if ( strval( $attribs['size'] ) == '1' ) {
427  unset( $attribs['size'] );
428  }
429  }
430  }
431 
432  return $attribs;
433  }
434 
474  public static function expandAttributes( array $attribs ) {
475  $ret = '';
476  foreach ( $attribs as $key => $value ) {
477  // Support intuitive [ 'checked' => true/false ] form
478  if ( $value === false || is_null( $value ) ) {
479  continue;
480  }
481 
482  // For boolean attributes, support [ 'foo' ] instead of
483  // requiring [ 'foo' => 'meaningless' ].
484  if ( is_int( $key ) && in_array( strtolower( $value ), self::$boolAttribs ) ) {
485  $key = $value;
486  }
487 
488  // Not technically required in HTML5 but we'd like consistency
489  // and better compression anyway.
490  $key = strtolower( $key );
491 
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.
500  'rel',
501  ];
502 
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
506 
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
511  $newValue = [];
512  foreach ( $value as $k => $v ) {
513  if ( is_string( $v ) ) {
514  // String values should be normal `array( 'foo' )`
515  // Just append them
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
520  $newValue[] = $v;
521  }
522  } elseif ( $v ) {
523  // If the value is truthy but not a string this is likely
524  // an [ 'foo' => true ], falsy values don't add strings
525  $newValue[] = $k;
526  }
527  }
528  $value = implode( ' ', $newValue );
529  }
530  $value = explode( ' ', $value );
531 
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, [ '', ' ' ] );
535 
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" );
540  }
541 
542  $quote = '"';
543 
544  if ( in_array( $key, self::$boolAttribs ) ) {
545  $ret .= " $key=\"\"";
546  } else {
547  $ret .= " $key=$quote" . Sanitizer::encodeAttribute( $value ) . $quote;
548  }
549  }
550  return $ret;
551  }
552 
562  public static function inlineScript( $contents ) {
563  $attrs = [];
564 
565  if ( preg_match( '/[<&]/', $contents ) ) {
566  $contents = "/*<![CDATA[*/$contents/*]]>*/";
567  }
568 
569  return self::rawElement( 'script', $attrs, $contents );
570  }
571 
579  public static function linkedScript( $url ) {
580  $attrs = [ 'src' => $url ];
581 
582  return self::element( 'script', $attrs );
583  }
584 
597  public static function inlineStyle( $contents, $media = 'all', $attribs = [] ) {
598  // Don't escape '>' since that is used
599  // as direct child selector.
600  // Remember, in css, there is no "x" for hexadecimal escapes, and
601  // the space immediately after an escape sequence is swallowed.
602  $contents = strtr( $contents, [
603  '<' => '\3C ',
604  // CDATA end tag for good measure, but the main security
605  // is from escaping the '<'.
606  ']]>' => '\5D\5D\3E '
607  ] );
608 
609  if ( preg_match( '/[<&]/', $contents ) ) {
610  $contents = "/*<![CDATA[*/$contents/*]]>*/";
611  }
612 
613  return self::rawElement( 'style', [
614  'media' => $media,
615  ] + $attribs, $contents );
616  }
617 
626  public static function linkedStyle( $url, $media = 'all' ) {
627  return self::element( 'link', [
628  'rel' => 'stylesheet',
629  'href' => $url,
630  'media' => $media,
631  ] );
632  }
633 
645  public static function input( $name, $value = '', $type = 'text', array $attribs = [] ) {
646  $attribs['type'] = $type;
647  $attribs['value'] = $value;
648  $attribs['name'] = $name;
649  if ( in_array( $type, [ 'text', 'search', 'email', 'password', 'number' ] ) ) {
651  }
652  if ( in_array( $type, [ 'button', 'reset', 'submit' ] ) ) {
654  }
655  return self::element( 'input', $attribs );
656  }
657 
666  public static function check( $name, $checked = false, array $attribs = [] ) {
667  if ( isset( $attribs['value'] ) ) {
668  $value = $attribs['value'];
669  unset( $attribs['value'] );
670  } else {
671  $value = 1;
672  }
673 
674  if ( $checked ) {
675  $attribs[] = 'checked';
676  }
677 
678  return self::input( $name, $value, 'checkbox', $attribs );
679  }
680 
689  private static function messageBox( $html, $className, $heading = '' ) {
690  if ( $heading ) {
691  $html = self::element( 'h2', [], $heading ) . $html;
692  }
693  return self::rawElement( 'div', [ 'class' => $className ], $html );
694  }
695 
702  public static function warningBox( $html ) {
703  return self::messageBox( $html, 'warningbox' );
704  }
705 
713  public static function errorBox( $html, $heading = '' ) {
714  return self::messageBox( $html, 'errorbox', $heading );
715  }
716 
723  public static function successBox( $html ) {
724  return self::messageBox( $html, 'successbox' );
725  }
726 
735  public static function radio( $name, $checked = false, array $attribs = [] ) {
736  if ( isset( $attribs['value'] ) ) {
737  $value = $attribs['value'];
738  unset( $attribs['value'] );
739  } else {
740  $value = 1;
741  }
742 
743  if ( $checked ) {
744  $attribs[] = 'checked';
745  }
746 
747  return self::input( $name, $value, 'radio', $attribs );
748  }
749 
758  public static function label( $label, $id, array $attribs = [] ) {
759  $attribs += [
760  'for' => $id
761  ];
762  return self::element( 'label', $attribs, $label );
763  }
764 
774  public static function hidden( $name, $value, array $attribs = [] ) {
775  return self::input( $name, $value, 'hidden', $attribs );
776  }
777 
790  public static function textarea( $name, $value = '', array $attribs = [] ) {
791  $attribs['name'] = $name;
792 
793  if ( substr( $value, 0, 1 ) == "\n" ) {
794  // Workaround for T14130: browsers eat the initial newline
795  // assuming that it's just for show, but they do keep the later
796  // newlines, which we may want to preserve during editing.
797  // Prepending a single newline
798  $spacedValue = "\n" . $value;
799  } else {
800  $spacedValue = $value;
801  }
802  return self::element( 'textarea', self::getTextInputAttributes( $attribs ), $spacedValue );
803  }
804 
810  public static function namespaceSelectorOptions( array $params = [] ) {
812 
813  $options = [];
814 
815  if ( !isset( $params['exclude'] ) || !is_array( $params['exclude'] ) ) {
816  $params['exclude'] = [];
817  }
818 
819  if ( isset( $params['all'] ) ) {
820  // add an option that would let the user select all namespaces.
821  // Value is provided by user, the name shown is localized for the user.
822  $options[$params['all']] = wfMessage( 'namespacesall' )->text();
823  }
824  // Add all namespaces as options (in the content language)
825  $options += $wgContLang->getFormattedNamespaces();
826 
827  $optionsOut = [];
828  // Filter out namespaces below 0 and massage labels
829  foreach ( $options as $nsId => $nsName ) {
830  if ( $nsId < NS_MAIN || in_array( $nsId, $params['exclude'] ) ) {
831  continue;
832  }
833  if ( $nsId === NS_MAIN ) {
834  // For other namespaces use the namespace prefix as label, but for
835  // main we don't use "" but the user message describing it (e.g. "(Main)" or "(Article)")
836  $nsName = wfMessage( 'blanknamespace' )->text();
837  } elseif ( is_int( $nsId ) ) {
838  $nsName = $wgContLang->convertNamespace( $nsId );
839  }
840  $optionsOut[$nsId] = $nsName;
841  }
842 
843  return $optionsOut;
844  }
845 
862  public static function namespaceSelector( array $params = [],
863  array $selectAttribs = []
864  ) {
865  ksort( $selectAttribs );
866 
867  // Is a namespace selected?
868  if ( isset( $params['selected'] ) ) {
869  // If string only contains digits, convert to clean int. Selected could also
870  // be "all" or "" etc. which needs to be left untouched.
871  // PHP is_numeric() has issues with large strings, PHP ctype_digit has other issues
872  // and returns false for already clean ints. Use regex instead..
873  if ( preg_match( '/^\d+$/', $params['selected'] ) ) {
874  $params['selected'] = intval( $params['selected'] );
875  }
876  // else: leaves it untouched for later processing
877  } else {
878  $params['selected'] = '';
879  }
880 
881  if ( !isset( $params['disable'] ) || !is_array( $params['disable'] ) ) {
882  $params['disable'] = [];
883  }
884 
885  // Associative array between option-values and option-labels
887 
888  // Convert $options to HTML
889  $optionsHtml = [];
890  foreach ( $options as $nsId => $nsName ) {
891  $optionsHtml[] = self::element(
892  'option', [
893  'disabled' => in_array( $nsId, $params['disable'] ),
894  'value' => $nsId,
895  'selected' => $nsId === $params['selected'],
896  ], $nsName
897  );
898  }
899 
900  if ( !array_key_exists( 'id', $selectAttribs ) ) {
901  $selectAttribs['id'] = 'namespace';
902  }
903 
904  if ( !array_key_exists( 'name', $selectAttribs ) ) {
905  $selectAttribs['name'] = 'namespace';
906  }
907 
908  $ret = '';
909  if ( isset( $params['label'] ) ) {
910  $ret .= self::element(
911  'label', [
912  'for' => isset( $selectAttribs['id'] ) ? $selectAttribs['id'] : null,
913  ], $params['label']
914  ) . '&#160;';
915  }
916 
917  // Wrap options in a <select>
918  $ret .= self::openElement( 'select', $selectAttribs )
919  . "\n"
920  . implode( "\n", $optionsHtml )
921  . "\n"
922  . self::closeElement( 'select' );
923 
924  return $ret;
925  }
926 
935  public static function htmlHeader( array $attribs = [] ) {
936  $ret = '';
937 
939 
940  $isXHTML = self::isXmlMimeType( $wgMimeType );
941 
942  if ( $isXHTML ) { // XHTML5
943  // XML MIME-typed markup should have an xml header.
944  // However a DOCTYPE is not needed.
945  $ret .= "<?xml version=\"1.0\" encoding=\"UTF-8\" ?" . ">\n";
946 
947  // Add the standard xmlns
948  $attribs['xmlns'] = 'http://www.w3.org/1999/xhtml';
949 
950  // And support custom namespaces
951  foreach ( $wgXhtmlNamespaces as $tag => $ns ) {
952  $attribs["xmlns:$tag"] = $ns;
953  }
954  } else { // HTML5
955  // DOCTYPE
956  $ret .= "<!DOCTYPE html>\n";
957  }
958 
959  if ( $wgHtml5Version ) {
960  $attribs['version'] = $wgHtml5Version;
961  }
962 
963  $ret .= self::openElement( 'html', $attribs );
964 
965  return $ret;
966  }
967 
974  public static function isXmlMimeType( $mimetype ) {
975  # https://html.spec.whatwg.org/multipage/infrastructure.html#xml-mime-type
976  # * text/xml
977  # * application/xml
978  # * Any MIME type with a subtype ending in +xml (this implicitly includes application/xhtml+xml)
979  return (bool)preg_match( '!^(text|application)/xml$|^.+/.+\+xml$!', $mimetype );
980  }
981 
992  static function infoBox( $text, $icon, $alt, $class = '' ) {
993  $s = self::openElement( 'div', [ 'class' => "mw-infobox $class" ] );
994 
995  $s .= self::openElement( 'div', [ 'class' => 'mw-infobox-left' ] ) .
996  self::element( 'img',
997  [
998  'src' => $icon,
999  'alt' => $alt,
1000  ]
1001  ) .
1002  self::closeElement( 'div' );
1003 
1004  $s .= self::openElement( 'div', [ 'class' => 'mw-infobox-right' ] ) .
1005  $text .
1006  self::closeElement( 'div' );
1007  $s .= self::element( 'div', [ 'style' => 'clear: left;' ], ' ' );
1008 
1009  $s .= self::closeElement( 'div' );
1010 
1011  $s .= self::element( 'div', [ 'style' => 'clear: left;' ], ' ' );
1012 
1013  return $s;
1014  }
1015 
1039  static function srcSet( array $urls ) {
1040  $candidates = [];
1041  foreach ( $urls as $density => $url ) {
1042  // Cast density to float to strip 'x', then back to string to serve
1043  // as array index.
1044  $density = (string)(float)$density;
1045  $candidates[$density] = $url;
1046  }
1047 
1048  // Remove duplicates that are the same as a smaller value
1049  ksort( $candidates, SORT_NUMERIC );
1050  $candidates = array_unique( $candidates );
1051 
1052  // Append density info to the url
1053  foreach ( $candidates as $density => $url ) {
1054  $candidates[$density] = $url . ' ' . $density . 'x';
1055  }
1056 
1057  return implode( ", ", $candidates );
1058  }
1059 }
Html\errorBox
static errorBox( $html, $heading='')
Return an error box.
Definition: Html.php:713
Html\linkButton
static linkButton( $contents, array $attrs, array $modifiers=[])
Returns an HTML link element in a string styled as a button (when $wgUseMediaWikiUIEverywhere is enab...
Definition: Html.php:165
Html\textarea
static textarea( $name, $value='', array $attribs=[])
Convenience function to produce a <textarea> element.
Definition: Html.php:790
$wgMimeType
$wgMimeType
The default Content-Type header.
Definition: DefaultSettings.php:3180
$html
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses & $html
Definition: hooks.txt:2013
wfMessage
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt
array
the array() calling protocol came about after MediaWiki 1.4rc1.
Html\getTextInputAttributes
static getTextInputAttributes(array $attrs)
Modifies a set of attributes meant for text input elements and apply a set of default attributes.
Definition: Html.php:136
string
This code would result in ircNotify being run twice when an article is and once for brion Hooks can return three possible true was required This is the default since MediaWiki *some string
Definition: hooks.txt:181
$ret
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
Definition: hooks.txt:2005
Html\check
static check( $name, $checked=false, array $attribs=[])
Convenience function to produce a checkbox (input element with type=checkbox)
Definition: Html.php:666
$wgUseMediaWikiUIEverywhere
$wgUseMediaWikiUIEverywhere
Temporary variable that applies MediaWiki UI wherever it can be supported.
Definition: DefaultSettings.php:3234
Html\expandAttributes
static expandAttributes(array $attribs)
Given an associative array of element attributes, generate a string to stick after the element name i...
Definition: Html.php:474
$params
$params
Definition: styleTest.css.php:40
Html\htmlHeader
static htmlHeader(array $attribs=[])
Constructs the opening html-tag with necessary doctypes depending on global variables.
Definition: Html.php:935
$s
$s
Definition: mergeMessageFileList.php:187
Html\inlineScript
static inlineScript( $contents)
Output a "<script>" tag with the given contents.
Definition: Html.php:562
Html\buttonAttributes
static buttonAttributes(array $attrs, array $modifiers=[])
Modifies a set of attributes meant for button elements and apply a set of default attributes when $wg...
Definition: Html.php:109
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
Html\successBox
static successBox( $html)
Return a success box.
Definition: Html.php:723
Html\input
static input( $name, $value='', $type='text', array $attribs=[])
Convenience function to produce an "<input>" element.
Definition: Html.php:645
NS_MAIN
const NS_MAIN
Definition: Defines.php:74
Html\closeElement
static closeElement( $element)
Returns "</$element>".
Definition: Html.php:309
Html\isXmlMimeType
static isXmlMimeType( $mimetype)
Determines if the given MIME type is xml.
Definition: Html.php:974
Html\srcSet
static srcSet(array $urls)
Generate a srcset attribute value.
Definition: Html.php:1039
MWException
MediaWiki exception.
Definition: MWException.php:26
Html\linkedScript
static linkedScript( $url)
Output a "<script>" tag linking to the given URL, e.g., "<script src=foo.js></script>".
Definition: Html.php:579
$wgHtml5Version
$wgHtml5Version
Defines the value of the version attribute in the <html> tag, if any.
Definition: DefaultSettings.php:3217
Html\dropDefaults
static dropDefaults( $element, array $attribs)
Given an element name and an associative array of element attributes, return an array that is functio...
Definition: Html.php:332
Sanitizer\encodeAttribute
static encodeAttribute( $text)
Encode an attribute value for HTML output.
Definition: Sanitizer.php:1130
Html\$voidElements
static $voidElements
Definition: Html.php:50
Html\radio
static radio( $name, $checked=false, array $attribs=[])
Convenience function to produce a radio button (input element with type=radio)
Definition: Html.php:735
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
Html\$boolAttribs
static $boolAttribs
Definition: Html.php:70
Html\warningBox
static warningBox( $html)
Return a warning box.
Definition: Html.php:702
Html\label
static label( $label, $id, array $attribs=[])
Convenience function for generating a label for inputs.
Definition: Html.php:758
Html\infoBox
static infoBox( $text, $icon, $alt, $class='')
Get HTML for an info box with an icon.
Definition: Html.php:992
$urls
$urls
Definition: opensearch_desc.php:76
$options
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
Definition: hooks.txt:2001
Html\inlineStyle
static inlineStyle( $contents, $media='all', $attribs=[])
Output a "<style>" tag with the given contents for the given media type (if any).
Definition: Html.php:597
Html\hidden
static hidden( $name, $value, array $attribs=[])
Convenience function to produce an input element with type=hidden.
Definition: Html.php:774
$attribs
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing & $attribs
Definition: hooks.txt:2014
$value
$value
Definition: styleTest.css.php:45
Html\namespaceSelectorOptions
static namespaceSelectorOptions(array $params=[])
Helper for Html::namespaceSelector().
Definition: Html.php:810
Html\namespaceSelector
static namespaceSelector(array $params=[], array $selectAttribs=[])
Build a drop-down box for selecting a namespace.
Definition: Html.php:862
Html\submitButton
static submitButton( $contents, array $attrs, array $modifiers=[])
Returns an HTML link element in a string styled as a button (when $wgUseMediaWikiUIEverywhere is enab...
Definition: Html.php:185
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
Html\linkedStyle
static linkedStyle( $url, $media='all')
Output a "<link rel=stylesheet>" linking to the given URL for the given media type (if any).
Definition: Html.php:626
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:22
Html\openElement
static openElement( $element, $attribs=[])
Identical to rawElement(), but has no third parameter and omits the end tag (and the self-closing '/'...
Definition: Html.php:251
Html\rawElement
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:209
$wgXhtmlNamespaces
$wgXhtmlNamespaces
Permit other namespaces in addition to the w3.org default.
Definition: DefaultSettings.php:3259
Html\element
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:231
Html\messageBox
static messageBox( $html, $className, $heading='')
Return the HTML for a message box.
Definition: Html.php:689
Html
This class is a collection of static functions that serve two purposes:
Definition: Html.php:48
$wgContLang
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the content language as $wgContLang
Definition: design.txt:57
$type
$type
Definition: testCompression.php:48