Fix documentation introduced in r64403
[lhc/web/wiklou.git] / includes / Html.php
index 4e37f10..b56a6d0 100644 (file)
@@ -1,5 +1,5 @@
 <?php
-# Copyright (C) 2009 Aryeh Gregor
+# Copyright © 2009 Aryeh Gregor
 # http://www.mediawiki.org/
 #
 # This program is free software; you can redistribute it and/or modify
@@ -38,6 +38,8 @@
  * This class is meant to be confined to utility functions that are called from
  * trusted code paths.  It does not do enforcement of policy like not allowing
  * <a> elements.
+ *
+ * @since 1.16
  */
 class Html {
        # List of void elements from HTML5, section 9.1.2 as of 2009-08-10
@@ -115,7 +117,7 @@ class Html {
                        }
                        return $start;
                } else {
-                       return "$start$contents</$element>";
+                       return "$start$contents" . self::closeElement( $element );
                }
        }
 
@@ -134,15 +136,23 @@ class Html {
 
        /**
         * Identical to rawElement(), but has no third parameter and omits the end
-        * tag (and the self-closing / in XML mode for empty elements).
+        * tag (and the self-closing '/' in XML mode for empty elements).
         */
        public static function openElement( $element, $attribs = array() ) {
-               global $wgHtml5;
+               global $wgHtml5, $wgWellFormedXml;
                $attribs = (array)$attribs;
                # This is not required in HTML5, but let's do it anyway, for
                # consistency and better compression.
                $element = strtolower( $element );
 
+               # In text/html, initial <html> and <head> tags can be omitted under
+               # pretty much any sane circumstances, if they have no attributes.  See:
+               # <http://www.whatwg.org/specs/web-apps/current-work/multipage/syntax.html#optional-tags>
+               if ( !$wgWellFormedXml && !$attribs
+               && in_array( $element, array( 'html', 'head' ) ) ) {
+                       return '';
+               }
+
                # Remove HTML5-only attributes if we aren't doing HTML5
                if ( !$wgHtml5 ) {
                        if ( $element == 'input' ) {
@@ -190,6 +200,36 @@ class Html {
                        self::dropDefaults( $element, $attribs ) ) . '>';
        }
 
+       /**
+        * Returns "</$element>", except if $wgWellFormedXml is off, in which case
+        * it returns the empty string when that's guaranteed to be safe.
+        *
+        * @param $element string Name of the element, e.g., 'a'
+        * @return string A closing tag, if required
+        */
+       public static function closeElement( $element ) {
+               global $wgWellFormedXml;
+
+               $element = strtolower( $element );
+
+               # Reference:
+               # http://www.whatwg.org/specs/web-apps/current-work/multipage/syntax.html#optional-tags
+               if ( !$wgWellFormedXml && in_array( $element, array(
+                       'html',
+                       'head',
+                       'body',
+                       'li',
+                       'dt',
+                       'dd',
+                       'tr',
+                       'td',
+                       'th',
+               ) ) ) {
+                       return '';
+               }
+               return "</$element>";
+       }
+
        /**
         * Given an element name and an associative array of element attributes,
         * return an array that is functionally identical to the input array, but