Use Title::newFromRow in ApiPageSet::processDbRow
[lhc/web/wiklou.git] / includes / Xml.php
index c48863f..6e4bb3a 100644 (file)
@@ -1,9 +1,28 @@
 <?php
+/**
+ * Methods to generate XML.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
 
 /**
  * Module of static functions for generating XML
  */
-
 class Xml {
        /**
         * Format an XML element with given attributes and, optionally, text content.
@@ -40,6 +59,7 @@ class Xml {
         * The values are passed to Sanitizer::encodeAttribute.
         * Return null if no attributes given.
         * @param $attribs Array of attributes for an XML element
+        * @return null|string
         */
        public static function expandAttributes( $attribs ) {
                $out = '';
@@ -117,42 +137,19 @@ class Xml {
         * @param $element_name String: value of the "name" attribute of the select tag
         * @param $label String: optional label to add to the field
         * @return string
+        * @deprecated since 1.19
         */
        public static function namespaceSelector( $selected = '', $all = null, $element_name = 'namespace', $label = null ) {
-               global $wgContLang;
-               $namespaces = $wgContLang->getFormattedNamespaces();
-               $options = array();
-
-               // Godawful hack... we'll be frequently passed selected namespaces
-               // as strings since PHP is such a shithole.
-               // But we also don't want blanks and nulls and "all"s matching 0,
-               // so let's convert *just* string ints to clean ints.
-               if( preg_match( '/^\d+$/', $selected ) ) {
-                       $selected = intval( $selected );
-               }
-
-               if( !is_null( $all ) )
-                       $namespaces = array( $all => wfMsg( 'namespacesall' ) ) + $namespaces;
-               foreach( $namespaces as $index => $name ) {
-                       if( $index < NS_MAIN ) {
-                               continue;
-                       }
-                       if( $index === 0 ) {
-                               $name = wfMsg( 'blanknamespace' );
-                       }
-                       $options[] = self::option( $name, $index, $index === $selected );
-               }
-
-               $ret = Xml::openElement( 'select', array( 'id' => 'namespace', 'name' => $element_name,
-                       'class' => 'namespaceselector' ) )
-                       . "\n"
-                       . implode( "\n", $options )
-                       . "\n"
-                       . Xml::closeElement( 'select' );
-               if ( !is_null( $label ) ) {
-                       $ret = Xml::label( $label, $element_name ) . '&#160;' . $ret;
-               }
-               return $ret;
+               wfDeprecated( __METHOD__, '1.19' );
+               return Html::namespaceSelector( array(
+                       'selected' => $selected,
+                       'all'      => $all,
+                       'label'    => $label,
+               ), array(
+                       'name'  => $element_name,
+                       'id'    => 'namespace',
+                       'class' => 'namespaceselector',
+               ) );
        }
 
        /**
@@ -208,21 +205,24 @@ class Xml {
        }
 
        /**
-        *
-        * @param $selected string The language code of the selected language
-        * @param $customisedOnly bool If true only languages which have some content are listed
-        * @return array of label and select
+        * Construct a language selector appropriate for use in a form or preferences
+        * 
+        * @param string $selected The language code of the selected language
+        * @param boolean $customisedOnly If true only languages which have some content are listed
+        * @param string $inLanguage The ISO code of the language to display the select list in (optional)
+        * @return array containing 2 items: label HTML and select list HTML
         */
-       public static function languageSelector( $selected, $customisedOnly = true ) {
+       public static function languageSelector( $selected, $customisedOnly = true, $inLanguage = null ) {
                global $wgLanguageCode;
-               /**
-                * Make sure the site language is in the list; a custom language code
-                * might not have a defined name...
-                */
-               $languages = Language::getLanguageNames( $customisedOnly );
+
+               $languages = Language::fetchLanguageNames( $inLanguage, $customisedOnly ? 'mwfile' : 'mw' );
+
+               // Make sure the site language is in the list; a custom language code might not have a
+               // defined name...
                if( !array_key_exists( $wgLanguageCode, $languages ) ) {
                        $languages[$wgLanguageCode] = $wgLanguageCode;
                }
+
                ksort( $languages );
 
                /**
@@ -259,8 +259,8 @@ class Xml {
 
        /**
         * Shortcut to make a specific element with a class attribute
-        * @param $text content of the element, will be escaped
-        * @param $class class name of the span element
+        * @param $text string content of the element, will be escaped
+        * @param $class string class name of the span element
         * @param $tag string element name
         * @param $attribs array other attributes
         * @return string
@@ -334,10 +334,10 @@ class Xml {
 
        /**
         * Convenience function to build an HTML radio button
-        * @param $name value of the name attribute
-        * @param $value value of the value attribute
-        * @param $checked Whether the checkbox is checked or not
-        * @param $attribs other attributes
+        * @param $name String value of the name attribute
+        * @param $value String value of the value attribute
+        * @param $checked Bool Whether the checkbox is checked or not
+        * @param $attribs Array other attributes
         * @return string HTML
         */
        public static function radio( $name, $value, $checked = false, $attribs = array() ) {
@@ -376,8 +376,8 @@ class Xml {
         * @param $label String text of the label
         * @param $name String value of the name attribute
         * @param $id String id of the input
-        * @param $size int value of the size attribute
-        * @param $value value of the value attribute
+        * @param $size Int|Bool value of the size attribute
+        * @param $value String|Bool value of the value attribute
         * @param $attribs array other attributes
         * @return string HTML
         */
@@ -389,11 +389,11 @@ class Xml {
        /**
         * Same as Xml::inputLabel() but return input and label in an array
         *
-        * @param $label
-        * @param $name
-        * @param $id
-        * @param $size
-        * @param $value
+        * @param $label String
+        * @param $name String
+        * @param $id String
+        * @param $size Int|Bool
+        * @param $value String|Bool
         * @param $attribs array
         *
         * @return array
@@ -466,7 +466,7 @@ class Xml {
                if( $selected ) {
                        $attribs['selected'] = 'selected';
                }
-               return self::element( 'option', $attribs, $text );
+               return Html::element( 'option', $attribs, $text );
        }
 
        /**
@@ -534,8 +534,8 @@ class Xml {
        /**
         * Shortcut for creating fieldsets.
         *
-        * @param $legend Legend of the fieldset. If evaluates to false, legend is not added.
-        * @param $content Pre-escaped content for the fieldset. If false, only open fieldset is returned.
+        * @param $legend string|bool Legend of the fieldset. If evaluates to false, legend is not added.
+        * @param $content string Pre-escaped content for the fieldset. If false, only open fieldset is returned.
         * @param $attribs array Any attributes to fieldset-element.
         *
         * @return string
@@ -635,7 +635,7 @@ class Xml {
                        $s = '[';
                        foreach ( $value as $elt ) {
                                if ( $s != '[' ) {
-                                       $s .= ', ';
+                                       $s .= ',';
                                }
                                $s .= self::encodeJsVar( $elt );
                        }
@@ -647,10 +647,10 @@ class Xml {
                        $s = '{';
                        foreach ( (array)$value as $name => $elt ) {
                                if ( $s != '{' ) {
-                                       $s .= ', ';
+                                       $s .= ',';
                                }
 
-                               $s .= '"' . self::escapeJsString( $name ) . '": ' .
+                               $s .= '"' . self::escapeJsString( $name ) . '":' .
                                        self::encodeJsVar( $elt );
                        }
                        $s .= '}';
@@ -794,6 +794,8 @@ class Xml {
                $s = Xml::openElement( 'table', $attribs );
 
                if ( is_array( $headers ) ) {
+                       $s .= Xml::openElement( 'thead', $attribs );
+
                        foreach( $headers as $id => $header ) {
                                $attribs = array();
 
@@ -803,6 +805,7 @@ class Xml {
 
                                $s .= Xml::element( 'th', $attribs, $header );
                        }
+                       $s .= Xml::closeElement( 'thead' );
                }
 
                foreach( $rows as $id => $row ) {
@@ -822,8 +825,8 @@ class Xml {
 
        /**
         * Build a row for a table
-        * @param $attribs An array of attributes to apply to the tr tag
-        * @param $cells An array of strings to put in <td>
+        * @param $attribs array An array of attributes to apply to the tr tag
+        * @param $cells array An array of strings to put in <td>
         * @return string
         */
        public static function buildTableRow( $attribs, $cells ) {
@@ -885,7 +888,7 @@ class XmlSelect {
         * @return array|null
         */
        public function getAttribute( $name ) {
-               if ( isset($this->attributes[$name]) ) {
+               if ( isset( $this->attributes[$name] ) ) {
                        return $this->attributes[$name];
                } else {
                        return null;
@@ -929,7 +932,7 @@ class XmlSelect {
                foreach( $options as $label => $value ) {
                        if ( is_array( $value ) ) {
                                $contents = self::formatOptions( $value, $default );
-                               $data .= Xml::tags( 'optgroup', array( 'label' => $label ), $contents ) . "\n";
+                               $data .= Html::rawElement( 'optgroup', array( 'label' => $label ), $contents ) . "\n";
                        } else {
                                $data .= Xml::option( $label, $value, $value === $default ) . "\n";
                        }
@@ -948,7 +951,7 @@ class XmlSelect {
                        $contents .= self::formatOptions( $options, $this->default );
                }
 
-               return Xml::tags( 'select', $this->attributes, rtrim( $contents ) );
+               return Html::rawElement( 'select', $this->attributes, rtrim( $contents ) );
        }
 }