4 * Module of static functions for generating XML
9 * Format an XML element with given attributes and, optionally, text content.
10 * Element and attribute names are assumed to be ready for literal inclusion.
11 * Strings are assumed to not contain XML-illegal characters; special
12 * characters (<, >, &) are escaped but illegals are not touched.
14 * @param $element String:
15 * @param $attribs Array: Name=>value pairs. Values will be escaped.
16 * @param $contents String: NULL to make an open tag only; '' for a contentless closed tag (default)
19 public static function element( $element, $attribs = null, $contents = '') {
20 $out = '<' . $element;
21 if( !is_null( $attribs ) ) {
22 $out .= self
::expandAttributes( $attribs );
24 if( is_null( $contents ) ) {
27 if( $contents === '' ) {
30 $out .= '>' . htmlspecialchars( $contents ) . "</$element>";
37 * Given an array of ('attributename' => 'value'), it generates the code
38 * to set the XML attributes : attributename="value".
39 * The values are passed to Sanitizer::encodeAttribute.
40 * Return null if no attributes given.
41 * @param $attribs Array of attributes for an XML element
43 private static function expandAttributes( $attribs ) {
45 if( is_null( $attribs ) ) {
47 } elseif( is_array( $attribs ) ) {
48 foreach( $attribs as $name => $val )
49 $out .= " {$name}=\"" . Sanitizer
::encodeAttribute( $val ) . '"';
52 throw new MWException( 'Expected attribute array, got something else in ' . __METHOD__
);
57 * Format an XML element as with self::element(), but run text through the
58 * UtfNormal::cleanUp() validator first to ensure that no invalid UTF-8
61 * @param $element String:
62 * @param $attribs Array: Name=>value pairs. Values will be escaped.
63 * @param $contents String: NULL to make an open tag only; '' for a contentless closed tag (default)
66 public static function elementClean( $element, $attribs = array(), $contents = '') {
68 $attribs = array_map( array( 'UtfNormal', 'cleanUp' ), $attribs );
71 wfProfileIn( __METHOD__
. '-norm' );
72 $contents = UtfNormal
::cleanUp( $contents );
73 wfProfileOut( __METHOD__
. '-norm' );
75 return self
::element( $element, $attribs, $contents );
78 /** This open an XML element */
79 public static function openElement( $element, $attribs = null ) {
80 return '<' . $element . self
::expandAttributes( $attribs ) . '>';
84 public static function closeElement( $element ) { return "</$element>"; }
87 * Same as <link>element</link>, but does not escape contents. Handy when the
88 * content you have is already valid xml.
90 public static function tags( $element, $attribs = null, $contents ) {
91 return self
::openElement( $element, $attribs ) . $contents . "</$element>";
95 * Build a drop-down box for selecting a namespace
97 * @param mixed $selected Namespace which should be pre-selected
98 * @param mixed $all Value of an item denoting all namespaces, or null to omit
99 * @param bool $hidden Include hidden namespaces? [WTF? --RC]
102 public static function namespaceSelector( $selected = '', $all = null, $hidden = false, $element_name = 'namespace' ) {
104 $namespaces = $wgContLang->getFormattedNamespaces();
107 if( !is_null( $all ) )
108 $namespaces = array( $all => wfMsg( 'namespacesall' ) ) +
$namespaces;
109 foreach( $namespaces as $index => $name ) {
110 if( $index < NS_MAIN
)
113 $name = wfMsg( 'blanknamespace' );
114 $options[] = self
::option( $name, $index, $index === $selected );
117 return Xml
::openElement( 'select', array( 'id' => 'namespace', 'name' => $element_name,
118 'class' => 'namespaceselector' ) )
120 . implode( "\n", $options )
122 . Xml
::closeElement( 'select' );
126 * Create a date selector
128 * @param $selected Mixed: the month which should be selected, default ''
129 * @param $allmonths String: value of a special item denoting all month. Null to not include (default)
130 * @param string $id Element identifier
131 * @return String: Html string containing the month selector
133 public static function monthSelector( $selected = '', $allmonths = null, $id = 'month' ) {
136 if( is_null( $selected ) )
138 if( !is_null( $allmonths ) )
139 $options[] = self
::option( wfMsg( 'monthsall' ), $allmonths, $selected === $allmonths );
140 for( $i = 1; $i < 13; $i++
)
141 $options[] = self
::option( $wgLang->getMonthName( $i ), $i, $selected === $i );
142 return self
::openElement( 'select', array( 'id' => $id, 'name' => 'month' ) )
143 . implode( "\n", $options )
144 . self
::closeElement( 'select' );
149 * @param $language The language code of the selected language
150 * @param $customisedOnly If true only languages which have some content are listed
151 * @return array of label and select
153 public static function languageSelector( $selected, $customisedOnly = true ) {
154 global $wgContLanguageCode;
156 * Make sure the site language is in the list; a custom language code
157 * might not have a defined name...
159 $languages = Language
::getLanguageNames( $customisedOnly );
160 if( !array_key_exists( $wgContLanguageCode, $languages ) ) {
161 $languages[$wgContLanguageCode] = $wgContLanguageCode;
166 * If a bogus value is set, default to the content language.
167 * Otherwise, no default is selected and the user ends up
168 * with an Afrikaans interface since it's first in the list.
170 $selected = isset( $languages[$selected] ) ?
$selected : $wgContLanguageCode;
172 foreach( $languages as $code => $name ) {
173 $options .= Xml
::option( "$code - $name", $code, ($code == $selected) ) . "\n";
177 Xml
::label( wfMsg('yourlanguage'), 'wpUserLanguage' ),
179 array( 'id' => 'wpUserLanguage', 'name' => 'wpUserLanguage' ),
186 public static function span( $text, $class, $attribs=array() ) {
187 return self
::element( 'span', array( 'class' => $class ) +
$attribs, $text );
191 * Convenience function to build an HTML text input field
192 * @return string HTML
194 public static function input( $name, $size=false, $value=false, $attribs=array() ) {
195 return self
::element( 'input', array(
198 'value' => $value ) +
$attribs );
202 * Convenience function to build an HTML password input field
203 * @return string HTML
205 public static function password( $name, $size=false, $value=false, $attribs=array() ) {
206 return self
::input( $name, $size, $value, array_merge($attribs, array('type' => 'password')));
210 * Internal function for use in checkboxes and radio buttons and such.
213 public static function attrib( $name, $present = true ) {
214 return $present ?
array( $name => $name ) : array();
218 * Convenience function to build an HTML checkbox
219 * @return string HTML
221 public static function check( $name, $checked=false, $attribs=array() ) {
222 return self
::element( 'input', array_merge(
225 'type' => 'checkbox',
227 self
::attrib( 'checked', $checked ),
232 * Convenience function to build an HTML radio button
233 * @return string HTML
235 public static function radio( $name, $value, $checked=false, $attribs=array() ) {
236 return self
::element( 'input', array(
239 'value' => $value ) + self
::attrib( 'checked', $checked ) +
$attribs );
243 * Convenience function to build an HTML form label
244 * @return string HTML
246 public static function label( $label, $id ) {
247 return self
::element( 'label', array( 'for' => $id ), $label );
251 * Convenience function to build an HTML text input field with a label
252 * @return string HTML
254 public static function inputLabel( $label, $name, $id, $size=false, $value=false, $attribs=array() ) {
255 return Xml
::label( $label, $id ) .
257 self
::input( $name, $size, $value, array( 'id' => $id ) +
$attribs );
261 * Convenience function to build an HTML checkbox with a label
262 * @return string HTML
264 public static function checkLabel( $label, $name, $id, $checked=false, $attribs=array() ) {
265 return self
::check( $name, $checked, array( 'id' => $id ) +
$attribs ) .
267 self
::label( $label, $id );
271 * Convenience function to build an HTML radio button with a label
272 * @return string HTML
274 public static function radioLabel( $label, $name, $value, $id, $checked=false, $attribs=array() ) {
275 return self
::radio( $name, $value, $checked, array( 'id' => $id ) +
$attribs ) .
277 self
::label( $label, $id );
281 * Convenience function to build an HTML submit button
282 * @param $value String: label text for the button
283 * @param $attribs Array: optional custom attributes
284 * @return string HTML
286 public static function submitButton( $value, $attribs=array() ) {
287 return self
::element( 'input', array( 'type' => 'submit', 'value' => $value ) +
$attribs );
291 * Convenience function to build an HTML hidden form field.
292 * @todo Document $name parameter.
294 * @param $value String: label text for the button
295 * @param $attribs Array: optional custom attributes
296 * @return string HTML
298 public static function hidden( $name, $value, $attribs=array() ) {
299 return self
::element( 'input', array(
302 'value' => $value ) +
$attribs );
306 * Convenience function to build an HTML drop-down list item.
307 * @param $text String: text for this item
308 * @param $value String: form submission value; if empty, use text
309 * @param $selected boolean: if true, will be the default selected item
310 * @param $attribs array: optional additional HTML attributes
311 * @return string HTML
313 public static function option( $text, $value=null, $selected=false,
315 if( !is_null( $value ) ) {
316 $attribs['value'] = $value;
319 $attribs['selected'] = 'selected';
321 return self
::element( 'option', $attribs, $text );
325 * Returns an escaped string suitable for inclusion in a string literal
326 * for JavaScript source code.
327 * Illegal control characters are assumed not to be present.
329 * @param string $string
332 public static function escapeJsString( $string ) {
333 // See ECMA 262 section 7.8.4 for string literal format
341 # To avoid closing the element or CDATA section
345 # To avoid any complaints about bad entity refs
348 # Work around https://bugzilla.mozilla.org/show_bug.cgi?id=274152
349 # Encode certain Unicode formatting chars so affected
350 # versions of Gecko don't misinterpret our strings;
351 # this is a common problem with Farsi text.
352 "\xe2\x80\x8c" => "\\u200c", // ZERO WIDTH NON-JOINER
353 "\xe2\x80\x8d" => "\\u200d", // ZERO WIDTH JOINER
355 return strtr( $string, $pairs );
359 * Encode a variable of unknown type to JavaScript.
360 * Arrays are converted to JS arrays, objects are converted to JS associative
361 * arrays (objects). So cast your PHP associative arrays to objects before
362 * passing them to here.
364 public static function encodeJsVar( $value ) {
365 if ( is_bool( $value ) ) {
366 $s = $value ?
'true' : 'false';
367 } elseif ( is_null( $value ) ) {
369 } elseif ( is_int( $value ) ) {
371 } elseif ( is_array( $value ) ) {
373 foreach ( $value as $elt ) {
377 $s .= self
::encodeJsVar( $elt );
380 } elseif ( is_object( $value ) ) {
382 foreach ( (array)$value as $name => $elt ) {
386 $s .= '"' . self
::escapeJsString( $name ) . '": ' .
387 self
::encodeJsVar( $elt );
391 $s = '"' . self
::escapeJsString( $value ) . '"';
398 * Check if a string is well-formed XML.
399 * Must include the surrounding tag.
401 * @param $text String: string to test.
404 * @todo Error position reporting return
406 public static function isWellFormed( $text ) {
407 $parser = xml_parser_create( "UTF-8" );
409 # case folding violates XML standard, turn it off
410 xml_parser_set_option( $parser, XML_OPTION_CASE_FOLDING
, false );
412 if( !xml_parse( $parser, $text, true ) ) {
413 //$err = xml_error_string( xml_get_error_code( $parser ) );
414 //$position = xml_get_current_byte_index( $parser );
415 //$fragment = $this->extractFragment( $html, $position );
416 //$this->mXmlError = "$err at byte $position:\n$fragment";
417 xml_parser_free( $parser );
420 xml_parser_free( $parser );
425 * Check if a string is a well-formed XML fragment.
426 * Wraps fragment in an \<html\> bit and doctype, so it can be a fragment
427 * and can use HTML named entities.
429 * @param $text String:
432 public static function isWellFormedXmlFragment( $text ) {
434 Sanitizer
::hackDocType() .
438 return Xml
::isWellFormed( $html );
442 * Replace " > and < with their respective HTML entities ( ",
445 * @param $in String: text that might contain HTML tags.
446 * @return string Escaped string
448 public static function escapeTagsOnly( $in ) {
450 array( '"', '>', '<' ),
451 array( '"', '>', '<' ),