X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2FXml.php;h=120312dd96727ad2b2d5e6e2fd0f82f3efd7e9f1;hb=3a39bb2560f15584d0fdec630a7652b2171fe5b4;hp=77b62632c488547d235501337b19a9a7a87c108c;hpb=e4c31083f16e5998eca8f01b8e999e73562567e6;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/Xml.php b/includes/Xml.php index 77b62632c4..120312dd96 100644 --- a/includes/Xml.php +++ b/includes/Xml.php @@ -1,9 +1,28 @@ 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 ) . ' ' . $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', + ) ); } /** @@ -169,7 +166,7 @@ class Xml { if( is_null( $selected ) ) $selected = ''; if( !is_null( $allmonths ) ) - $options[] = self::option( wfMsg( 'monthsall' ), $allmonths, $selected === $allmonths ); + $options[] = self::option( wfMessage( 'monthsall' )->text(), $allmonths, $selected === $allmonths ); for( $i = 1; $i < 13; $i++ ) $options[] = self::option( $wgLang->getMonthName( $i ), $i, $selected === $i ); return self::openElement( 'select', array( 'id' => $id, 'name' => 'month', 'class' => 'mw-month-selector' ) ) @@ -191,7 +188,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 ) { @@ -201,34 +198,40 @@ class Xml { } else { $encYear = ''; } - return Xml::label( wfMsg( 'year' ), 'year' ) . ' '. + return Xml::label( wfMessage( 'year' )->text(), 'year' ) . ' '. Xml::input( 'year', 4, $encYear, array('id' => 'year', 'maxlength' => 4) ) . ' '. - Xml::label( wfMsg( 'month' ), 'month' ) . ' '. + Xml::label( wfMessage( 'month' )->text(), 'month' ) . ' '. Xml::monthSelector( $encMonth, -1 ); } /** - * - * @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 $inLanguage The ISO code of the language to display the select list in (optional) + * @param array $overrideAttrs Override the attributes of the select tag (since 1.20) + * @param Message|null $msg Label message key (since 1.20) + * @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, $overrideAttrs = array(), Message $msg = 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 ); + + $include = $customisedOnly ? 'mwfile' : 'mw'; + $languages = Language::fetchLanguageNames( $inLanguage, $include ); + + // 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 ); /** * If a bogus value is set, default to the content language. * Otherwise, no default is selected and the user ends up - * with an Afrikaans interface since it's first in the list. + * with Afrikaans since it's first in the list. */ $selected = isset( $languages[$selected] ) ? $selected : $wgLanguageCode; $options = "\n"; @@ -236,12 +239,15 @@ class Xml { $options .= Xml::option( "$code - $name", $code, ($code == $selected) ) . "\n"; } + $attrs = array( 'id' => 'wpUserLanguage', 'name' => 'wpUserLanguage' ); + $attrs = array_merge( $attrs, $overrideAttrs ); + + if( $msg === null ) { + $msg = wfMessage( 'yourlanguage' ); + } return array( - Xml::label( wfMsg('yourlanguage'), 'wpUserLanguage' ), - Xml::tags( 'select', - array( 'id' => 'wpUserLanguage', 'name' => 'wpUserLanguage' ), - $options - ) + Xml::label( $msg->text(), $attrs['id'] ), + Xml::tags( 'select', $attrs, $options ) ); } @@ -250,34 +256,34 @@ 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 ); } /** * 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 $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 */ - 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 +299,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 +328,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 +340,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 +357,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 +382,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 +413,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 +430,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,17 +452,10 @@ 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 ); } - /** - * @deprecated Synonymous to Html::hidden() - */ - public static function hidden( $name, $value, $attribs = array() ) { - return Html::hidden( $name, $value, $attribs ); - } - /** * Convenience function to build an HTML drop-down list item. * @param $text String: text for this item @@ -431,15 +464,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 ); } /** @@ -479,19 +512,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 @@ -502,15 +540,19 @@ 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 $attribs Any attributes to fieldset-element. + * @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 */ 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"; @@ -522,11 +564,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', @@ -569,6 +613,7 @@ class Xml { "\xe2\x80\x8c" => "\\u200c", // ZERO WIDTH NON-JOINER "\xe2\x80\x8d" => "\\u200d", // ZERO WIDTH JOINER ); + return strtr( $string, $pairs ); } @@ -577,6 +622,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 ) ) { @@ -592,7 +641,7 @@ class Xml { $s = '['; foreach ( $value as $elt ) { if ( $s != '[' ) { - $s .= ', '; + $s .= ','; } $s .= self::encodeJsVar( $elt ); } @@ -604,9 +653,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 .= '}'; @@ -617,30 +667,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. @@ -664,7 +720,9 @@ class Xml { xml_parser_free( $parser ); return false; } + xml_parser_free( $parser ); + return true; } @@ -682,6 +740,7 @@ class Xml { '' . $text . ''; + return Xml::isWellFormed( $html ); } @@ -713,7 +772,7 @@ class Xml { 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::tags( 'td', array('class' => 'mw-label'), wfMessage( $labelmsg )->parse() ); $form .= Xml::openElement( 'td', array( 'class' => 'mw-input' ) ) . $input . Xml::closeElement( 'td' ); $form .= Xml::closeElement( 'tr' ); } @@ -721,55 +780,77 @@ class Xml { 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::openElement( 'td', array( 'class' => 'mw-submit' ) ) . Xml::submitButton( wfMessage( $submitLabel )->text() ) . Xml::closeElement( 'td' ); $form .= Xml::closeElement( 'tr' ); } $form .= ""; - 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 + * @param $attribs array An array of attributes to apply to the tr tag + * @param $cells array An array of strings to put in * @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; } } @@ -783,52 +864,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"; } @@ -837,15 +947,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: