Fix grammar in 'mimesearch-summary'
[lhc/web/wiklou.git] / includes / Xml.php
index 1551878..4dfc9e6 100644 (file)
@@ -46,8 +46,9 @@ class Xml {
                if( is_null( $attribs ) ) {
                        return null;
                } elseif( is_array( $attribs ) ) {
-                       foreach( $attribs as $name => $val )
+                       foreach( $attribs as $name => $val ) {
                                $out .= " {$name}=\"" . Sanitizer::encodeAttribute( $val ) . '"';
+                       }
                        return $out;
                } else {
                        throw new MWException( 'Expected attribute array, got something else in ' . __METHOD__ );
@@ -56,7 +57,7 @@ class Xml {
 
        /**
         * Format an XML element as with self::element(), but run text through the
-        * UtfNormal::cleanUp() validator first to ensure that no invalid UTF-8
+        * $wgContLang->normalize() validator first to ensure that no invalid UTF-8
         * is passed.
         *
         * @param $element String:
@@ -65,12 +66,13 @@ class Xml {
         * @return string
         */
        public static function elementClean( $element, $attribs = array(), $contents = '') {
+               global $wgContLang;
                if( $attribs ) {
                        $attribs = array_map( array( 'UtfNormal', 'cleanUp' ), $attribs );
                }
                if( $contents ) {
                        wfProfileIn( __METHOD__ . '-norm' );
-                       $contents = UtfNormal::cleanUp( $contents );
+                       $contents = $wgContLang->normalize( $contents );
                        wfProfileOut( __METHOD__ . '-norm' );
                }
                return self::element( $element, $attribs, $contents );
@@ -112,11 +114,11 @@ class Xml {
         *
         * @param $selected Mixed: Namespace which should be pre-selected
         * @param $all Mixed: Value of an item denoting all namespaces, or null to omit
-        * @param $hidden Mixed: Include hidden namespaces? [WTF? --RC]
         * @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
         */
-       public static function namespaceSelector( $selected = '', $all = null, $hidden = false, $element_name = 'namespace' ) {
+       public static function namespaceSelector( $selected = '', $all = null, $element_name = 'namespace', $label = null ) {
                global $wgContLang;
                $namespaces = $wgContLang->getFormattedNamespaces();
                $options = array();
@@ -132,19 +134,25 @@ class Xml {
                if( !is_null( $all ) )
                        $namespaces = array( $all => wfMsg( 'namespacesall' ) ) + $namespaces;
                foreach( $namespaces as $index => $name ) {
-                       if( $index < NS_MAIN )
+                       if( $index < NS_MAIN ) {
                                continue;
-                       if( $index === 0 )
+                       }
+                       if( $index === 0 ) {
                                $name = wfMsg( 'blanknamespace' );
+                       }
                        $options[] = self::option( $name, $index, $index === $selected );
                }
 
-               return Xml::openElement( 'select', array( 'id' => 'namespace', 'name' => $element_name,
+               $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;
        }
 
        /**
@@ -158,17 +166,47 @@ class Xml {
        public static function monthSelector( $selected = '', $allmonths = null, $id = 'month' ) {
                global $wgLang;
                $options = array();
-           if( is_null( $selected ) )
+               if( is_null( $selected ) )
                        $selected = '';
-           if( !is_null( $allmonths ) )
+               if( !is_null( $allmonths ) )
                        $options[] = self::option( wfMsg( 'monthsall' ), $allmonths, $selected === $allmonths );
                for( $i = 1; $i < 13; $i++ )
-                               $options[] = self::option( $wgLang->getMonthName( $i ), $i, $selected === $i );
+                       $options[] = self::option( $wgLang->getMonthName( $i ), $i, $selected === $i );
                return self::openElement( 'select', array( 'id' => $id, 'name' => 'month', 'class' => 'mw-month-selector' ) )
                        . implode( "\n", $options )
                        . self::closeElement( 'select' );
        }
 
+       /**
+        * @param $year Integer
+        * @param $month Integer
+        * @return string Formatted HTML
+        */
+       public static function dateMenu( $year, $month ) {
+               # Offset overrides year/month selection
+               if( $month && $month !== -1 ) {
+                       $encMonth = intval( $month );
+               } else {
+                       $encMonth = '';
+               }
+               if( $year ) {
+                       $encYear = intval( $year );
+               } else if( $encMonth ) {
+                       $thisMonth = intval( gmdate( 'n' ) );
+                       $thisYear = intval( gmdate( 'Y' ) );
+                       if( intval($encMonth) > $thisMonth ) {
+                               $thisYear--;
+                       }
+                       $encYear = $thisYear;
+               } else {
+                       $encYear = '';
+               }
+               return Xml::label( wfMsg( 'year' ), 'year' ) . ' '.
+                       Xml::input( 'year', 4, $encYear, array('id' => 'year', 'maxlength' => 4) ) . ' '.
+                       Xml::label( wfMsg( 'month' ), 'month' ) . ' '.
+                       Xml::monthSelector( $encMonth, -1 );
+       }
+
        /**
         *
         * @param $selected The language code of the selected language
@@ -176,14 +214,14 @@ class Xml {
         * @return array of label and select
         */
        public static function languageSelector( $selected, $customisedOnly = true ) {
-               global $wgContLanguageCode;
+               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( !array_key_exists( $wgContLanguageCode, $languages ) ) {
-                       $languages[$wgContLanguageCode] = $wgContLanguageCode;
+               if( !array_key_exists( $wgLanguageCode, $languages ) ) {
+                       $languages[$wgLanguageCode] = $wgLanguageCode;
                }
                ksort( $languages );
 
@@ -192,7 +230,7 @@ class Xml {
                 * Otherwise, no default is selected and the user ends up
                 * with an Afrikaans interface since it's first in the list.
                 */
-               $selected = isset( $languages[$selected] ) ? $selected : $wgContLanguageCode;
+               $selected = isset( $languages[$selected] ) ? $selected : $wgLanguageCode;
                $options = "\n";
                foreach( $languages as $code => $name ) {
                        $options .= Xml::option( "$code - $name", $code, ($code == $selected) ) . "\n";
@@ -213,7 +251,7 @@ class Xml {
         * @param $text content of the element, will be escaped
         * @param $class class name of the span element
         * @param $attribs other attributes
-        * @return string 
+        * @return string
         */
        public static function span( $text, $class, $attribs=array() ) {
                return self::element( 'span', array( 'class' => $class ) + $attribs, $text );
@@ -225,7 +263,7 @@ class Xml {
         * @param $class class name of the span element
         * @param $tag element name
         * @param $attribs other attributes
-        * @return string 
+        * @return string
         */
        public static function wrapClass( $text, $class, $tag='span', $attribs=array() ) {
                return self::tags( $tag, array( 'class' => $class ) + $attribs, $text );
@@ -240,10 +278,17 @@ class Xml {
         * @return string HTML
         */
        public static function input( $name, $size=false, $value=false, $attribs=array() ) {
-               return self::element( 'input', array(
-                       'name' => $name,
-                       'size' => $size,
-                       'value' => $value ) + $attribs );
+               $attributes = array( 'name' => $name );
+
+               if( $size ) {
+                       $attributes['size'] = $size;
+               }
+
+               if( $value !== false ) { // maybe 0
+                       $attributes['value'] = $value;
+               }
+
+               return self::element( 'input', $attributes + $attribs );
        }
 
        /**
@@ -301,11 +346,16 @@ class Xml {
        /**
         * Convenience function to build an HTML form label
         * @param $label text of the label
-        * @param $id 
+        * @param $id
+        * @param $attribs Array, other attributes
         * @return string HTML
         */
-       public static function label( $label, $id ) {
-               return self::element( 'label', array( 'for' => $id ), $label );
+       public static function label( $label, $id, $attribs=array() ) {
+               $a = array( 'for' => $id );
+               if( isset( $attribs['class'] ) ){
+                               $a['class'] = $attribs['class'];
+               }
+               return self::element( 'label', $a, $label );
        }
 
        /**
@@ -320,7 +370,7 @@ class Xml {
         */
        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 . '&nbsp;' . $input;
+               return $label . '&#160;' . $input;
        }
 
        /**
@@ -328,7 +378,7 @@ class Xml {
         */
        public static function inputLabelSep( $label, $name, $id, $size=false, $value=false, $attribs=array() ) {
                return array(
-                       Xml::label( $label, $id ),
+                       Xml::label( $label, $id, $attribs ),
                        self::input( $name, $size, $value, array( 'id' => $id ) + $attribs )
                );
        }
@@ -339,8 +389,8 @@ class Xml {
         */
        public static function checkLabel( $label, $name, $id, $checked=false, $attribs=array() ) {
                return self::check( $name, $checked, array( 'id' => $id ) + $attribs ) .
-                       '&nbsp;' .
-                       self::label( $label, $id );
+                       '&#160;' .
+                       self::label( $label, $id, $attribs );
        }
 
        /**
@@ -349,8 +399,8 @@ class Xml {
         */
        public static function radioLabel( $label, $name, $value, $id, $checked=false, $attribs=array() ) {
                return self::radio( $name, $value, $checked, array( 'id' => $id ) + $attribs ) .
-                       '&nbsp;' .
-                       self::label( $label, $id );
+                       '&#160;' .
+                       self::label( $label, $id, $attribs );
        }
 
        /**
@@ -360,21 +410,14 @@ class Xml {
         * @return string HTML
         */
        public static function submitButton( $value, $attribs=array() ) {
-               return self::element( 'input', array( 'type' => 'submit', 'value' => $value ) + $attribs );
+               return Html::element( 'input', array( 'type' => 'submit', 'value' => $value ) + $attribs );
        }
 
        /**
-        * Convenience function to build an HTML hidden form field.
-        * @param $name String: name attribute for the field
-        * @param $value String: value for the hidden field
-        * @param $attribs Array: optional custom attributes
-        * @return string HTML
+        * @deprecated Synonymous to Html::hidden()
         */
-       public static function hidden( $name, $value, $attribs=array() ) {
-               return self::element( 'input', array(
-                       'name' => $name,
-                       'type' => 'hidden',
-                       'value' => $value ) + $attribs );
+       public static function hidden( $name, $value, $attribs = array() ) {
+               return Html::hidden( $name, $value, $attribs );
        }
 
        /**
@@ -473,7 +516,7 @@ class Xml {
 
                return $s;
        }
-       
+
        /**
         * Shortcut for creating textareas.
         *
@@ -540,7 +583,10 @@ class Xml {
                        $s = 'null';
                } elseif ( is_int( $value ) ) {
                        $s = $value;
-               } elseif ( is_array( $value ) ) {
+               } elseif ( is_array( $value ) && // Make sure it's not associative.
+                                       array_keys($value) === range( 0, count($value) - 1 ) ||
+                                       count($value) == 0
+                               ) {
                        $s = '[';
                        foreach ( $value as $elt ) {
                                if ( $s != '[' ) {
@@ -549,7 +595,8 @@ class Xml {
                                $s .= self::encodeJsVar( $elt );
                        }
                        $s .= ']';
-               } elseif ( is_object( $value ) ) {
+               } elseif ( is_object( $value ) || is_array( $value ) ) {
+                       // Objects and associative arrays
                        $s = '{';
                        foreach ( (array)$value as $name => $elt ) {
                                if ( $s != '{' ) {
@@ -623,7 +670,7 @@ class Xml {
                        array( '&quot;', '&gt;', '&lt;' ),
                        $in );
        }
-       
+
        /**
        * Generate a form (without the opening form element).
        * Output optionally includes a submit button.
@@ -634,24 +681,69 @@ class Xml {
        public static function buildForm( $fields, $submitLabel = null ) {
                $form = '';
                $form .= "<table><tbody>";
-       
+
                foreach( $fields as $labelmsg => $input ) {
                        $id = "mw-$labelmsg";
-                       
                        $form .= Xml::openElement( 'tr', array( 'id' => $id ) );
                        $form .= Xml::tags( 'td', array('class' => 'mw-label'), wfMsgExt( $labelmsg, array('parseinline') ) );
-                       $form .= Xml::openElement( 'td' ) . $input . Xml::closeElement( 'td' );
+                       $form .= Xml::openElement( 'td', array( 'class' => 'mw-input' ) ) . $input . Xml::closeElement( 'td' );
                        $form .= Xml::closeElement( 'tr' );
                }
-       
-               $form .= "</tbody></table>";
-               
-               if ($submitLabel) {     
-                       $form .= Xml::submitButton( wfMsg($submitLabel) );
+
+               if( $submitLabel ) {
+                       $form .= Xml::openElement( 'tr' );
+                       $form .= Xml::tags( 'td', array(), '' );
+                       $form .= Xml::openElement( 'td', array( 'class' => 'mw-submit' ) ) . Xml::submitButton( wfMsg( $submitLabel ) ) . Xml::closeElement( 'td' );
+                       $form .= Xml::closeElement( 'tr' );
                }
-       
+
+               $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]
+        * @return string
+        */
+       public static function buildTable( $rows, $attribs = array(), $headers = null ) {
+               $s = Xml::openElement( 'table', $attribs );
+               if ( is_array( $headers ) ) {
+                       foreach( $headers as $id => $header ) {
+                               $attribs = array();
+                               if ( is_string( $id ) ) $attribs['id'] = $id;
+                               $s .= Xml::element( 'th', $attribs, $header );
+                       }
+               }
+               foreach( $rows as $id => $row ) {
+                       $attribs = array();
+                       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>
+        * @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;
+                       $s .= Xml::element( 'td', $attribs, $cell );
+               }
+               $s .= Xml::closeElement( 'tr' );
+               return $s;
+       }
 }
 
 class XmlSelect {
@@ -660,9 +752,15 @@ class XmlSelect {
        protected $attributes = array();
 
        public function __construct( $name = false, $id = false, $default = false ) {
-               if ( $name ) $this->setAttribute( 'name', $name );
-               if ( $id ) $this->setAttribute( 'id', $id );
-               if ( $default ) $this->default = $default;
+               if ( $name ) {
+                       $this->setAttribute( 'name', $name );
+               }
+               if ( $id ) {
+                       $this->setAttribute( 'id', $id );
+               }
+               if ( $default !== false ) {
+                       $this->default = $default;
+               }
        }
 
        public function setDefault( $default ) {
@@ -673,11 +771,44 @@ class XmlSelect {
                $this->attributes[$name] = $value;
        }
 
+       public function getAttribute( $name ) {
+               if ( isset($this->attributes[$name]) ) {
+                       return $this->attributes[$name];
+               } else {
+                       return null;
+               }
+       }
+
        public function addOption( $name, $value = false ) {
-               $value = $value ? $value : $name;
+               // Stab stab stab
+               $value = ($value !== false) ? $value : $name;
                $this->options[] = Xml::option( $name, $value, $value === $this->default );
        }
 
+       // This accepts an array of form
+       // label => value
+       // label => ( label => value, label => value )
+       public function addOptions( $options ) {
+               $this->options[] = trim(self::formatOptions( $options, $this->default ));
+       }
+
+       // This accepts an array of form
+       // label => value
+       // label => ( label => value, label => value )
+       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";
+                       } else {
+                               $data .= Xml::option( $label, $value, $value === $default ) . "\n";
+                       }
+               }
+
+               return $data;
+       }
+
        public function getHTML() {
                return Xml::tags( 'select', $this->attributes, implode( "\n", $this->options ) );
        }