Remove no-op codepath
[lhc/web/wiklou.git] / includes / Xml.php
index 72df1da..fc4392a 100644 (file)
@@ -191,7 +191,7 @@ class Xml {
                }
                if( $year ) {
                        $encYear = intval( $year );
-               } else if( $encMonth ) {
+               } elseif( $encMonth ) {
                        $thisMonth = intval( gmdate( 'n' ) );
                        $thisYear = intval( gmdate( 'Y' ) );
                        if( intval($encMonth) > $thisMonth ) {
@@ -208,21 +208,39 @@ class Xml {
        }
 
        /**
-        *
-        * @param $selected The language code of the selected language
-        * @param $customisedOnly 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 $language 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, $language = 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 );
+
+               // If a specific language was requested and CLDR is installed, use it
+               if ( $language && is_callable( array( 'LanguageNames', 'getNames' ) ) ) {
+                       if ( $customisedOnly ) {
+                               $listType = LanguageNames::LIST_MW_SUPPORTED; // Only pull names that have localisation in MediaWiki
+                       } else {
+                               $listType = LanguageNames::LIST_MW; // Pull all languages that are in Names.php
+                       }
+                       // Retrieve the list of languages in the requested language (via CLDR)
+                       $languages = LanguageNames::getNames(
+                               $language, // Code of the requested language
+                               LanguageNames::FALLBACK_NORMAL, // Use fallback chain
+                               $listType
+                       );
+               } else {
+                       $languages = Language::getLanguageNames( $customisedOnly );
+               }
+               
+               // 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 );
 
                /**
@@ -250,10 +268,10 @@ class Xml {
         * Shortcut to make a span element
         * @param $text String content of the element, will be escaped
         * @param $class String class name of the span element
-        * @param $attribs other attributes
+        * @param $attribs array other attributes
         * @return string
         */
-       public static function span( $text, $class, $attribs=array() ) {
+       public static function span( $text, $class, $attribs = array() ) {
                return self::element( 'span', array( 'class' => $class ) + $attribs, $text );
        }
 
@@ -261,23 +279,23 @@ 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 $tag element name
-        * @param $attribs other attributes
+        * @param $tag string element name
+        * @param $attribs array other attributes
         * @return string
         */
-       public static function wrapClass( $text, $class, $tag='span', $attribs=array() ) {
+       public static function wrapClass( $text, $class, $tag = 'span', $attribs = array() ) {
                return self::tags( $tag, array( 'class' => $class ) + $attribs, $text );
        }
 
        /**
         * Convenience function to build an HTML text input field
         * @param $name String value of the name attribute
-        * @param $size value of the size attribute
-        * @param $value value of the value attribute
-        * @param $attribs other attributes
+        * @param $size int value of the size attribute
+        * @param $value mixed value of the value attribute
+        * @param $attribs array other attributes
         * @return string HTML
         */
-       public static function input( $name, $size=false, $value=false, $attribs=array() ) {
+       public static function input( $name, $size = false, $value = false, $attribs = array() ) {
                $attributes = array( 'name' => $name );
 
                if( $size ) {
@@ -293,18 +311,22 @@ class Xml {
 
        /**
         * Convenience function to build an HTML password input field
-        * @param $name value of the name attribute
-        * @param $size value of the size attribute
-        * @param $value value of the value attribute
-        * @param $attribs other attributes
+        * @param $name string value of the name attribute
+        * @param $size int value of the size attribute
+        * @param $value mixed value of the value attribute
+        * @param $attribs array other attributes
         * @return string HTML
         */
-       public static function password( $name, $size=false, $value=false, $attribs=array() ) {
-               return self::input( $name, $size, $value, array_merge($attribs, array('type' => 'password')));
+       public static function password( $name, $size = false, $value = false, $attribs = array() ) {
+               return self::input( $name, $size, $value, array_merge( $attribs, array( 'type' => 'password' ) ) );
        }
 
        /**
         * Internal function for use in checkboxes and radio buttons and such.
+        *
+        * @param $name string
+        * @param $present bool
+        *
         * @return array
         */
        public static function attrib( $name, $present = true ) {
@@ -318,7 +340,7 @@ class Xml {
         * @param $attribs Array other attributes
         * @return string HTML
         */
-       public static function check( $name, $checked=false, $attribs=array() ) {
+       public static function check( $name, $checked = false, $attribs=array() ) {
                return self::element( 'input', array_merge(
                        array(
                                'name' => $name,
@@ -330,13 +352,13 @@ 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() ) {
+       public static function radio( $name, $value, $checked = false, $attribs = array() ) {
                return self::element( 'input', array(
                        'name' => $name,
                        'type' => 'radio',
@@ -347,17 +369,23 @@ class Xml {
         * Convenience function to build an HTML form label
         * @param $label String text of the label
         * @param $id
-        * @param $attribs Array an attribute array.  This will usuall be 
+        * @param $attribs Array an attribute array.  This will usuall be
         *     the same array as is passed to the corresponding input element,
-        *     so this function will cherry-pick appropriate attributes to 
-        *     apply to the label as well; currently only class is applied.
+        *     so this function will cherry-pick appropriate attributes to
+        *     apply to the label as well; only class and title are applied.
         * @return string HTML
         */
-       public static function label( $label, $id, $attribs=array() ) {
+       public static function label( $label, $id, $attribs = array() ) {
                $a = array( 'for' => $id );
+
+               # FIXME avoid copy pasting below:
                if( isset( $attribs['class'] ) ){
                                $a['class'] = $attribs['class'];
                }
+               if( isset( $attribs['title'] ) ){
+                               $a['title'] = $attribs['title'];
+               }
+
                return self::element( 'label', $a, $label );
        }
 
@@ -366,20 +394,29 @@ 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 value of the size attribute
-        * @param $value value of the value attribute
-        * @param $attribs other attributes
+        * @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
         */
-       public static function inputLabel( $label, $name, $id, $size=false, $value=false, $attribs=array() ) {
+       public static function inputLabel( $label, $name, $id, $size=false, $value=false, $attribs = array() ) {
                list( $label, $input ) = self::inputLabelSep( $label, $name, $id, $size, $value, $attribs );
                return $label . ' ' . $input;
        }
 
        /**
         * Same as Xml::inputLabel() but return input and label in an array
+        *
+        * @param $label String
+        * @param $name String
+        * @param $id String
+        * @param $size Int|Bool
+        * @param $value String|Bool
+        * @param $attribs array
+        *
+        * @return array
         */
-       public static function inputLabelSep( $label, $name, $id, $size=false, $value=false, $attribs=array() ) {
+       public static function inputLabelSep( $label, $name, $id, $size = false, $value = false, $attribs = array() ) {
                return array(
                        Xml::label( $label, $id, $attribs ),
                        self::input( $name, $size, $value, array( 'id' => $id ) + $attribs )
@@ -388,9 +425,16 @@ class Xml {
 
        /**
         * Convenience function to build an HTML checkbox with a label
+        *
+        * @param $label
+        * @param $name
+        * @param $id
+        * @param $checked bool
+        * @param $attribs array
+        *
         * @return string HTML
         */
-       public static function checkLabel( $label, $name, $id, $checked=false, $attribs=array() ) {
+       public static function checkLabel( $label, $name, $id, $checked = false, $attribs = array() ) {
                return self::check( $name, $checked, array( 'id' => $id ) + $attribs ) .
                        ' ' .
                        self::label( $label, $id, $attribs );
@@ -398,9 +442,17 @@ class Xml {
 
        /**
         * Convenience function to build an HTML radio button with a label
+        *
+        * @param $label
+        * @param $name
+        * @param $value
+        * @param $id
+        * @param $checked bool
+        * @param $attribs array
+        *
         * @return string HTML
         */
-       public static function radioLabel( $label, $name, $value, $id, $checked=false, $attribs=array() ) {
+       public static function radioLabel( $label, $name, $value, $id, $checked = false, $attribs = array() ) {
                return self::radio( $name, $value, $checked, array( 'id' => $id ) + $attribs ) .
                        ' ' .
                        self::label( $label, $id, $attribs );
@@ -412,7 +464,7 @@ class Xml {
         * @param $attribs Array: optional custom attributes
         * @return string HTML
         */
-       public static function submitButton( $value, $attribs=array() ) {
+       public static function submitButton( $value, $attribs = array() ) {
                return Html::element( 'input', array( 'type' => 'submit', 'value' => $value ) + $attribs );
        }
 
@@ -424,15 +476,15 @@ class Xml {
         * @param $attribs array: optional additional HTML attributes
         * @return string HTML
         */
-       public static function option( $text, $value=null, $selected=false,
-                       $attribs=array() ) {
+       public static function option( $text, $value=null, $selected = false,
+                       $attribs = array() ) {
                if( !is_null( $value ) ) {
                        $attribs['value'] = $value;
                }
                if( $selected ) {
                        $attribs['selected'] = 'selected';
                }
-               return self::element( 'option', $attribs, $text );
+               return Html::element( 'option', $attribs, $text );
        }
 
        /**
@@ -472,19 +524,24 @@ class Xml {
                                        $optgroup = false;
                                }
                        }
+
                        if( $optgroup ) $options .= self::closeElement('optgroup');
 
                $attribs = array();
+
                if( $name ) {
                        $attribs['id'] = $name;
                        $attribs['name'] = $name;
                }
+
                if( $class ) {
                        $attribs['class'] = $class;
                }
+
                if( $tabindex ) {
                        $attribs['tabindex'] = $tabindex;
                }
+
                return Xml::openElement( 'select', $attribs )
                        . "\n"
                        . $options
@@ -497,13 +554,17 @@ class Xml {
         *
         * @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 $attribs Any attributes to fieldset-element.
+        * @param $attribs array Any attributes to fieldset-element.
+        *
+        * @return string
         */
        public static function fieldset( $legend = false, $content = false, $attribs = array() ) {
                $s = Xml::openElement( 'fieldset', $attribs ) . "\n";
+
                if ( $legend ) {
                        $s .= Xml::element( 'legend', null, $legend ) . "\n";
                }
+
                if ( $content !== false ) {
                        $s .= $content . "\n";
                        $s .= Xml::closeElement( 'fieldset' ) . "\n";
@@ -515,11 +576,13 @@ class Xml {
        /**
         * Shortcut for creating textareas.
         *
-        * @param $name The 'name' for the textarea
-        * @param $content Content for the textarea
-        * @param $cols The number of columns for the textarea
-        * @param $rows The number of rows for the textarea
-        * @param $attribs Any other attributes for the textarea
+        * @param $name string The 'name' for the textarea
+        * @param $content string Content for the textarea
+        * @param $cols int The number of columns for the textarea
+        * @param $rows int The number of rows for the textarea
+        * @param $attribs array Any other attributes for the textarea
+        *
+        * @return string
         */
        public static function textarea( $name, $content, $cols = 40, $rows = 5, $attribs = array() ) {
                return self::element( 'textarea',
@@ -562,6 +625,7 @@ class Xml {
                        "\xe2\x80\x8c" => "\\u200c", // ZERO WIDTH NON-JOINER
                        "\xe2\x80\x8d" => "\\u200d", // ZERO WIDTH JOINER
                );
+
                return strtr( $string, $pairs );
        }
 
@@ -570,6 +634,10 @@ class Xml {
         * Arrays are converted to JS arrays, objects are converted to JS associative
         * arrays (objects). So cast your PHP associative arrays to objects before
         * passing them to here.
+        *
+        * @param $value
+        *
+        * @return string
         */
        public static function encodeJsVar( $value ) {
                if ( is_bool( $value ) ) {
@@ -599,6 +667,7 @@ class Xml {
                                if ( $s != '{' ) {
                                        $s .= ', ';
                                }
+
                                $s .= '"' . self::escapeJsString( $name ) . '": ' .
                                        self::encodeJsVar( $elt );
                        }
@@ -610,30 +679,36 @@ class Xml {
        }
 
        /**
-        * Create a call to a JavaScript function. The supplied arguments will be 
-        * encoded using Xml::encodeJsVar(). 
+        * Create a call to a JavaScript function. The supplied arguments will be
+        * encoded using Xml::encodeJsVar().
         *
         * @param $name String The name of the function to call, or a JavaScript expression
         *    which evaluates to a function object which is called.
         * @param $args Array of arguments to pass to the function.
+        *
         * @since 1.17
+        *
+        * @return string
         */
        public static function encodeJsCall( $name, $args ) {
                $s = "$name(";
                $first = true;
+
                foreach ( $args as $arg ) {
                        if ( $first ) {
                                $first = false;
                        } else {
                                $s .= ', ';
                        }
+
                        $s .= Xml::encodeJsVar( $arg );
                }
+
                $s .= ");\n";
+
                return $s;
        }
 
-
        /**
         * Check if a string is well-formed XML.
         * Must include the surrounding tag.
@@ -657,7 +732,9 @@ class Xml {
                        xml_parser_free( $parser );
                        return false;
                }
+
                xml_parser_free( $parser );
+
                return true;
        }
 
@@ -675,6 +752,7 @@ class Xml {
                        '<html>' .
                        $text .
                        '</html>';
+
                return Xml::isWellFormed( $html );
        }
 
@@ -720,90 +798,71 @@ class Xml {
 
                $form .= "</tbody></table>";
 
-
                return $form;
        }
 
        /**
         * Build a table of data
-        * @param $rows An array of arrays of strings, each to be a row in a table
-        * @param $attribs An array of attributes to apply to the table tag [optional]
-        * @param $headers An array of strings to use as table headers [optional]
+        * @param $rows array An array of arrays of strings, each to be a row in a table
+        * @param $attribs array An array of attributes to apply to the table tag [optional]
+        * @param $headers array An array of strings to use as table headers [optional]
         * @return string
         */
        public static function buildTable( $rows, $attribs = array(), $headers = null ) {
                $s = Xml::openElement( 'table', $attribs );
+
                if ( is_array( $headers ) ) {
+                       $s .= Xml::openElement( 'thead', $attribs );
+
                        foreach( $headers as $id => $header ) {
                                $attribs = array();
-                               if ( is_string( $id ) ) $attribs['id'] = $id;
+
+                               if ( is_string( $id ) ) {
+                                       $attribs['id'] = $id;
+                               }
+
                                $s .= Xml::element( 'th', $attribs, $header );
                        }
+                       $s .= Xml::closeElement( 'thead' );
                }
+
                foreach( $rows as $id => $row ) {
                        $attribs = array();
-                       if ( is_string( $id ) ) $attribs['id'] = $id;
+
+                       if ( is_string( $id ) ) {
+                               $attribs['id'] = $id;
+                       }
+
                        $s .= Xml::buildTableRow( $attribs, $row );
                }
+
                $s .= Xml::closeElement( 'table' );
+
                return $s;
        }
 
        /**
         * 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 ) {
                $s = Xml::openElement( 'tr', $attribs );
+
                foreach( $cells as $id => $cell ) {
+
                        $attribs = array();
-                       if ( is_string( $id ) ) $attribs['id'] = $id;
+
+                       if ( is_string( $id ) ) {
+                               $attribs['id'] = $id;
+                       }
+
                        $s .= Xml::element( 'td', $attribs, $cell );
                }
+
                $s .= Xml::closeElement( 'tr' );
-               return $s;
-       }
 
-       /**
-        * Get HTML for an info box with an icon.
-        *
-        * @param $text String: wikitext, get this with wfMsgNoTrans()
-        * @param $icon String: icon name, file in skins/common/images
-        * @param $alt  String: alternate text for the icon
-        * @param $class String: additional class name to add to the wrapper div
-        *
-        * @return string
-        */
-       static function infoBox( $text, $icon, $alt, $class = false, $useStypePath = true ) {
-               global $wgStylePath;
-               
-               if ( $useStypePath ) {
-                       $icon = $wgStylePath.'/common/images/'.$icon;
-               }
-               
-               
-               $s  = Xml::openElement( 'div', array( 'class' => "mw-infobox $class") );
-               
-               $s .= Xml::openElement( 'div', array( 'class' => 'mw-infobox-left' ) ).
-                               Html::element( 'img',
-                                       array(
-                                               'src' => $icon,
-                                               'alt' => $alt,
-                                       )
-                               ).
-                               Xml::closeElement( 'div' );
-
-               $s .= Xml::openElement( 'div', array( 'class' => 'mw-infobox-right' ) ).
-                               $text.
-                               Xml::closeElement( 'div' );
-               $s .= Xml::element( 'div', array( 'style' => 'clear: left;' ), ' ' );
-
-               $s .= Xml::closeElement( 'div' );
-
-               $s .= Xml::element( 'div', array( 'style' => 'clear: left;' ), ' ' );
-               
                return $s;
        }
 }
@@ -817,52 +876,81 @@ class XmlSelect {
                if ( $name ) {
                        $this->setAttribute( 'name', $name );
                }
+
                if ( $id ) {
                        $this->setAttribute( 'id', $id );
                }
+
                if ( $default !== false ) {
                        $this->default = $default;
                }
        }
 
+       /**
+        * @param $default
+        */
        public function setDefault( $default ) {
                $this->default = $default;
        }
 
+       /**
+        * @param $name string
+        * @param $value
+        */
        public function setAttribute( $name, $value ) {
                $this->attributes[$name] = $value;
        }
 
+       /**
+        * @param $name
+        * @return array|null
+        */
        public function getAttribute( $name ) {
-               if ( isset($this->attributes[$name]) ) {
+               if ( isset( $this->attributes[$name] ) ) {
                        return $this->attributes[$name];
                } else {
                        return null;
                }
        }
 
+       /**
+        * @param $name
+        * @param $value bool
+        */
        public function addOption( $name, $value = false ) {
                // Stab stab stab
                $value = ($value !== false) ? $value : $name;
-               $this->options[] = Xml::option( $name, $value, $value === $this->default );
+
+               $this->options[] = array( $name => $value );
        }
 
-       // This accepts an array of form
-       // label => value
-       // label => ( label => value, label => value )
+       /**
+        * This accepts an array of form
+        * label => value
+        * label => ( label => value, label => value )
+        *
+        * @param  $options
+        */
        public function addOptions( $options ) {
-               $this->options[] = trim(self::formatOptions( $options, $this->default ));
+               $this->options[] = $options;
        }
 
-       // This accepts an array of form
-       // label => value
-       // label => ( label => value, label => value )
+       /**
+        * This accepts an array of form
+        * label => value
+        * label => ( label => value, label => value )
+        *
+        * @param  $options
+        * @param bool $default
+        * @return string
+        */
        static function formatOptions( $options, $default = false ) {
                $data = '';
+
                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";
                        }
@@ -871,15 +959,23 @@ class XmlSelect {
                return $data;
        }
 
+       /**
+        * @return string
+        */
        public function getHTML() {
-               return Xml::tags( 'select', $this->attributes, implode( "\n", $this->options ) );
-       }
+               $contents = '';
 
+               foreach ( $this->options as $options ) {
+                       $contents .= self::formatOptions( $options, $this->default );
+               }
+
+               return Html::rawElement( 'select', $this->attributes, rtrim( $contents ) );
+       }
 }
 
 /**
- * A wrapper class which causes Xml::encodeJsVar() and Xml::encodeJsCall() to 
- * interpret a given string as being a JavaScript expression, instead of string 
+ * A wrapper class which causes Xml::encodeJsVar() and Xml::encodeJsCall() to
+ * interpret a given string as being a JavaScript expression, instead of string
  * data.
  *
  * Example: