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 ) {
44 if( is_null( $attribs ) ) {
48 foreach( $attribs as $name => $val ) {
49 $out .= ' ' . $name . '="' . Sanitizer
::encodeAttribute( $val ) . '"';
56 * Format an XML element as with self::element(), but run text through the
57 * UtfNormal::cleanUp() validator first to ensure that no invalid UTF-8
60 * @param $element String:
61 * @param $attribs Array: Name=>value pairs. Values will be escaped.
62 * @param $contents String: NULL to make an open tag only; '' for a contentless closed tag (default)
65 public static function elementClean( $element, $attribs = array(), $contents = '') {
67 $attribs = array_map( array( 'UtfNormal', 'cleanUp' ), $attribs );
70 wfProfileIn( __METHOD__
. '-norm' );
71 $contents = UtfNormal
::cleanUp( $contents );
72 wfProfileOut( __METHOD__
. '-norm' );
74 return self
::element( $element, $attribs, $contents );
77 /** This open an XML element */
78 public static function openElement( $element, $attribs = null ) {
79 return '<' . $element . self
::expandAttributes( $attribs ) . '>';
83 public static function closeElement( $element ) { return "</$element>"; }
86 * Same as <link>element</link>, but does not escape contents. Handy when the
87 * content you have is already valid xml.
89 public static function tags( $element, $attribs = null, $contents ) {
90 return self
::openElement( $element, $attribs ) . $contents . "</$element>";
94 * Create a namespace selector
96 * @param $selected Mixed: the namespace which should be selected, default ''
97 * @param $allnamespaces String: value of a special item denoting all namespaces. Null to not include (default)
98 * @param $includehidden Bool: include hidden namespaces?
99 * @param array $exclude Array of namespace indexes to exclude
100 * @return String: Html string containing the namespace selector
102 public static function namespaceSelector($selected = '', $allnamespaces = null, $includehidden=false, $exclude = array() ) {
104 if( is_null( $selected ) )
106 $s = "\n<select id='namespace' name='namespace' class='namespaceselector'>\n";
107 $arr = $wgContLang->getFormattedNamespaces();
108 if( !is_null($allnamespaces) ) {
109 $arr = array($allnamespaces => wfMsg('namespacesall')) +
$arr;
111 foreach ($arr as $index => $name) {
112 if( $index < NS_MAIN ||
in_array( $index, $exclude ) )
115 $name = $index !== 0 ?
$name : wfMsg('blanknamespace');
117 if ($index === $selected) {
118 $s .= "\t" . self
::element("option",
119 array("value" => $index, "selected" => "selected"),
122 $s .= "\t" . self
::element("option", array("value" => $index), $name) . "\n";
130 * Create a date selector
132 * @param $selected Mixed: the month which should be selected, default ''
133 * @param $allmonths String: value of a special item denoting all month. Null to not include (default)
134 * @param string $id Element identifier
135 * @return String: Html string containing the month selector
137 public static function monthSelector( $selected = '', $allmonths = null, $id = 'month' ) {
140 if( is_null( $selected ) )
142 if( !is_null( $allmonths ) )
143 $options[] = self
::option( wfMsg( 'monthsall' ), $allmonths, $selected === $allmonths );
144 for( $i = 1; $i < 13; $i++
)
145 $options[] = self
::option( $wgLang->getMonthName( $i ), $i, $selected === $i );
146 return self
::openElement( 'select', array( 'id' => $id, 'name' => 'month' ) )
147 . implode( "\n", $options )
148 . self
::closeElement( 'select' );
153 * @param $language The language code of the selected language
154 * @param $customisedOnly If true only languages which have some content are listed
155 * @return array of label and select
157 public static function languageSelector( $selected, $customisedOnly = true ) {
158 global $wgContLanguageCode;
160 * Make sure the site language is in the list; a custom language code
161 * might not have a defined name...
163 $languages = Language
::getLanguageNames( $customisedOnly );
164 if( !array_key_exists( $wgContLanguageCode, $languages ) ) {
165 $languages[$wgContLanguageCode] = $wgContLanguageCode;
170 * If a bogus value is set, default to the content language.
171 * Otherwise, no default is selected and the user ends up
172 * with an Afrikaans interface since it's first in the list.
174 $selected = isset( $languages[$selected] ) ?
$selected : $wgContLanguageCode;
176 foreach( $languages as $code => $name ) {
177 $options .= Xml
::option( "$code - $name", $code, ($code == $selected) ) . "\n";
181 Xml
::label( wfMsg('yourlanguage'), 'wpUserLanguage' ),
183 array( 'id' => 'wpUserLanguage', 'name' => 'wpUserLanguage' ),
190 public static function span( $text, $class, $attribs=array() ) {
191 return self
::element( 'span', array( 'class' => $class ) +
$attribs, $text );
195 * Convenience function to build an HTML text input field
196 * @return string HTML
198 public static function input( $name, $size=false, $value=false, $attribs=array() ) {
199 return self
::element( 'input', array(
202 'value' => $value ) +
$attribs );
206 * Convenience function to build an HTML password input field
207 * @return string HTML
209 public static function password( $name, $size=false, $value=false, $attribs=array() ) {
210 return self
::input( $name, $size, $value, array_merge($attribs, array('type' => 'password')));
214 * Internal function for use in checkboxes and radio buttons and such.
217 public static function attrib( $name, $present = true ) {
218 return $present ?
array( $name => $name ) : array();
222 * Convenience function to build an HTML checkbox
223 * @return string HTML
225 public static function check( $name, $checked=false, $attribs=array() ) {
226 return self
::element( 'input', array_merge(
229 'type' => 'checkbox',
231 self
::attrib( 'checked', $checked ),
236 * Convenience function to build an HTML radio button
237 * @return string HTML
239 public static function radio( $name, $value, $checked=false, $attribs=array() ) {
240 return self
::element( 'input', array(
243 'value' => $value ) + self
::attrib( 'checked', $checked ) +
$attribs );
247 * Convenience function to build an HTML form label
248 * @return string HTML
250 public static function label( $label, $id ) {
251 return self
::element( 'label', array( 'for' => $id ), $label );
255 * Convenience function to build an HTML text input field with a label
256 * @return string HTML
258 public static function inputLabel( $label, $name, $id, $size=false, $value=false, $attribs=array() ) {
259 return Xml
::label( $label, $id ) .
261 self
::input( $name, $size, $value, array( 'id' => $id ) +
$attribs );
265 * Convenience function to build an HTML checkbox with a label
266 * @return string HTML
268 public static function checkLabel( $label, $name, $id, $checked=false, $attribs=array() ) {
269 return self
::check( $name, $checked, array( 'id' => $id ) +
$attribs ) .
271 self
::label( $label, $id );
275 * Convenience function to build an HTML radio button with a label
276 * @return string HTML
278 public static function radioLabel( $label, $name, $value, $id, $checked=false, $attribs=array() ) {
279 return self
::radio( $name, $value, $checked, array( 'id' => $id ) +
$attribs ) .
281 self
::label( $label, $id );
285 * Convenience function to build an HTML submit button
286 * @param $value String: label text for the button
287 * @param $attribs Array: optional custom attributes
288 * @return string HTML
290 public static function submitButton( $value, $attribs=array() ) {
291 return self
::element( 'input', array( 'type' => 'submit', 'value' => $value ) +
$attribs );
295 * Convenience function to build an HTML hidden form field.
296 * @todo Document $name parameter.
298 * @param $value String: label text for the button
299 * @param $attribs Array: optional custom attributes
300 * @return string HTML
302 public static function hidden( $name, $value, $attribs=array() ) {
303 return self
::element( 'input', array(
306 'value' => $value ) +
$attribs );
310 * Convenience function to build an HTML drop-down list item.
311 * @param $text String: text for this item
312 * @param $value String: form submission value; if empty, use text
313 * @param $selected boolean: if true, will be the default selected item
314 * @param $attribs array: optional additional HTML attributes
315 * @return string HTML
317 public static function option( $text, $value=null, $selected=false,
319 if( !is_null( $value ) ) {
320 $attribs['value'] = $value;
323 $attribs['selected'] = 'selected';
325 return self
::element( 'option', $attribs, $text );
329 * Returns an escaped string suitable for inclusion in a string literal
330 * for JavaScript source code.
331 * Illegal control characters are assumed not to be present.
333 * @param string $string
336 public static function escapeJsString( $string ) {
337 // See ECMA 262 section 7.8.4 for string literal format
345 # To avoid closing the element or CDATA section
349 # To avoid any complaints about bad entity refs
352 # Work around https://bugzilla.mozilla.org/show_bug.cgi?id=274152
353 # Encode certain Unicode formatting chars so affected
354 # versions of Gecko don't misinterpret our strings;
355 # this is a common problem with Farsi text.
356 "\xe2\x80\x8c" => "\\u200c", // ZERO WIDTH NON-JOINER
357 "\xe2\x80\x8d" => "\\u200d", // ZERO WIDTH JOINER
359 return strtr( $string, $pairs );
363 * Encode a variable of unknown type to JavaScript.
364 * Arrays are converted to JS arrays, objects are converted to JS associative
365 * arrays (objects). So cast your PHP associative arrays to objects before
366 * passing them to here.
368 public static function encodeJsVar( $value ) {
369 if ( is_bool( $value ) ) {
370 $s = $value ?
'true' : 'false';
371 } elseif ( is_null( $value ) ) {
373 } elseif ( is_int( $value ) ) {
375 } elseif ( is_array( $value ) ) {
377 foreach ( $value as $elt ) {
381 $s .= self
::encodeJsVar( $elt );
384 } elseif ( is_object( $value ) ) {
386 foreach ( (array)$value as $name => $elt ) {
390 $s .= '"' . self
::escapeJsString( $name ) . '": ' .
391 self
::encodeJsVar( $elt );
395 $s = '"' . self
::escapeJsString( $value ) . '"';
402 * Check if a string is well-formed XML.
403 * Must include the surrounding tag.
405 * @param $text String: string to test.
408 * @todo Error position reporting return
410 public static function isWellFormed( $text ) {
411 $parser = xml_parser_create( "UTF-8" );
413 # case folding violates XML standard, turn it off
414 xml_parser_set_option( $parser, XML_OPTION_CASE_FOLDING
, false );
416 if( !xml_parse( $parser, $text, true ) ) {
417 //$err = xml_error_string( xml_get_error_code( $parser ) );
418 //$position = xml_get_current_byte_index( $parser );
419 //$fragment = $this->extractFragment( $html, $position );
420 //$this->mXmlError = "$err at byte $position:\n$fragment";
421 xml_parser_free( $parser );
424 xml_parser_free( $parser );
429 * Check if a string is a well-formed XML fragment.
430 * Wraps fragment in an \<html\> bit and doctype, so it can be a fragment
431 * and can use HTML named entities.
433 * @param $text String:
436 public static function isWellFormedXmlFragment( $text ) {
438 Sanitizer
::hackDocType() .
442 return Xml
::isWellFormed( $html );
446 * Replace " > and < with their respective HTML entities ( ",
449 * @param $in String: text that might contain HTML tags.
450 * @return string Escaped string
452 public static function escapeTagsOnly( $in ) {
454 array( '"', '>', '<' ),
455 array( '"', '>', '<' ),