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 * @return String: Html string containing the namespace selector
101 public static function namespaceSelector($selected = '', $allnamespaces = null, $includehidden=false) {
103 if( is_null( $selected ) )
105 $s = "\n<select id='namespace' name='namespace' class='namespaceselector'>\n";
106 $arr = $wgContLang->getFormattedNamespaces();
107 if( !is_null($allnamespaces) ) {
108 $arr = array($allnamespaces => wfMsg('namespacesall')) +
$arr;
110 foreach ($arr as $index => $name) {
111 if ($index < NS_MAIN
) continue;
113 $name = $index !== 0 ?
$name : wfMsg('blanknamespace');
115 if ($index === $selected) {
116 $s .= "\t" . self
::element("option",
117 array("value" => $index, "selected" => "selected"),
120 $s .= "\t" . self
::element("option", array("value" => $index), $name) . "\n";
129 * @param $language The language code of the selected language
130 * @param $customisedOnly If true only languages which have some content are listed
131 * @return array of label and select
133 public static function languageSelector( $selected, $customisedOnly = true ) {
134 global $wgContLanguageCode;
136 * Make sure the site language is in the list; a custom language code
137 * might not have a defined name...
139 $languages = Language
::getLanguageNames( $customisedOnly );
140 if( !array_key_exists( $wgContLanguageCode, $languages ) ) {
141 $languages[$wgContLanguageCode] = $wgContLanguageCode;
146 * If a bogus value is set, default to the content language.
147 * Otherwise, no default is selected and the user ends up
148 * with an Afrikaans interface since it's first in the list.
150 $selected = isset( $languages[$selected] ) ?
$selected : $wgContLanguageCode;
152 foreach( $languages as $code => $name ) {
153 $options .= Xml
::option( "$code - $name", $code, ($code == $selected) ) . "\n";
157 Xml
::label( wfMsg('yourlanguage'), 'wpUserLanguage' ),
159 array( 'id' => 'wpUserLanguage', 'name' => 'wpUserLanguage' ),
166 public static function span( $text, $class, $attribs=array() ) {
167 return self
::element( 'span', array( 'class' => $class ) +
$attribs, $text );
171 * Convenience function to build an HTML text input field
172 * @return string HTML
174 public static function input( $name, $size=false, $value=false, $attribs=array() ) {
175 return self
::element( 'input', array(
178 'value' => $value ) +
$attribs );
182 * Convenience function to build an HTML password input field
183 * @return string HTML
185 public static function password( $name, $size=false, $value=false, $attribs=array() ) {
186 return self
::input( $name, $size, $value, array_merge($attribs, array('type' => 'password')));
190 * Internal function for use in checkboxes and radio buttons and such.
193 public static function attrib( $name, $present = true ) {
194 return $present ?
array( $name => $name ) : array();
198 * Convenience function to build an HTML checkbox
199 * @return string HTML
201 public static function check( $name, $checked=false, $attribs=array() ) {
202 return self
::element( 'input', array_merge(
205 'type' => 'checkbox',
207 self
::attrib( 'checked', $checked ),
212 * Convenience function to build an HTML radio button
213 * @return string HTML
215 public static function radio( $name, $value, $checked=false, $attribs=array() ) {
216 return self
::element( 'input', array(
219 'value' => $value ) + self
::attrib( 'checked', $checked ) +
$attribs );
223 * Convenience function to build an HTML form label
224 * @return string HTML
226 public static function label( $label, $id ) {
227 return self
::element( 'label', array( 'for' => $id ), $label );
231 * Convenience function to build an HTML text input field with a label
232 * @return string HTML
234 public static function inputLabel( $label, $name, $id, $size=false, $value=false, $attribs=array() ) {
235 return Xml
::label( $label, $id ) .
237 self
::input( $name, $size, $value, array( 'id' => $id ) +
$attribs );
241 * Convenience function to build an HTML checkbox with a label
242 * @return string HTML
244 public static function checkLabel( $label, $name, $id, $checked=false, $attribs=array() ) {
245 return self
::check( $name, $checked, array( 'id' => $id ) +
$attribs ) .
247 self
::label( $label, $id );
251 * Convenience function to build an HTML radio button with a label
252 * @return string HTML
254 public static function radioLabel( $label, $name, $value, $id, $checked=false, $attribs=array() ) {
255 return self
::radio( $name, $value, $checked, array( 'id' => $id ) +
$attribs ) .
257 self
::label( $label, $id );
261 * Convenience function to build an HTML submit button
262 * @param $value String: label text for the button
263 * @param $attribs Array: optional custom attributes
264 * @return string HTML
266 public static function submitButton( $value, $attribs=array() ) {
267 return self
::element( 'input', array( 'type' => 'submit', 'value' => $value ) +
$attribs );
271 * Convenience function to build an HTML hidden form field.
272 * @todo Document $name parameter.
274 * @param $value String: label text for the button
275 * @param $attribs Array: optional custom attributes
276 * @return string HTML
278 public static function hidden( $name, $value, $attribs=array() ) {
279 return self
::element( 'input', array(
282 'value' => $value ) +
$attribs );
286 * Convenience function to build an HTML drop-down list item.
287 * @param $text String: text for this item
288 * @param $value String: form submission value; if empty, use text
289 * @param $selected boolean: if true, will be the default selected item
290 * @param $attribs array: optional additional HTML attributes
291 * @return string HTML
293 public static function option( $text, $value=null, $selected=false,
295 if( !is_null( $value ) ) {
296 $attribs['value'] = $value;
299 $attribs['selected'] = 'selected';
301 return self
::element( 'option', $attribs, $text );
305 * Returns an escaped string suitable for inclusion in a string literal
306 * for JavaScript source code.
307 * Illegal control characters are assumed not to be present.
309 * @param string $string
312 public static function escapeJsString( $string ) {
313 // See ECMA 262 section 7.8.4 for string literal format
321 # To avoid closing the element or CDATA section
325 # To avoid any complaints about bad entity refs
328 return strtr( $string, $pairs );
332 * Encode a variable of unknown type to JavaScript.
333 * Doesn't support hashtables just yet.
335 public static function encodeJsVar( $value ) {
336 if ( is_bool( $value ) ) {
337 $s = $value ?
'true' : 'false';
338 } elseif ( is_null( $value ) ) {
340 } elseif ( is_int( $value ) ) {
342 } elseif ( is_array( $value ) ) {
344 foreach ( $value as $name => $elt ) {
348 $s .= self
::encodeJsVar( $elt );
352 $s = '"' . self
::escapeJsString( $value ) . '"';
359 * Check if a string is well-formed XML.
360 * Must include the surrounding tag.
362 * @param $text String: string to test.
365 * @todo Error position reporting return
367 public static function isWellFormed( $text ) {
368 $parser = xml_parser_create( "UTF-8" );
370 # case folding violates XML standard, turn it off
371 xml_parser_set_option( $parser, XML_OPTION_CASE_FOLDING
, false );
373 if( !xml_parse( $parser, $text, true ) ) {
374 //$err = xml_error_string( xml_get_error_code( $parser ) );
375 //$position = xml_get_current_byte_index( $parser );
376 //$fragment = $this->extractFragment( $html, $position );
377 //$this->mXmlError = "$err at byte $position:\n$fragment";
378 xml_parser_free( $parser );
381 xml_parser_free( $parser );
386 * Check if a string is a well-formed XML fragment.
387 * Wraps fragment in an \<html\> bit and doctype, so it can be a fragment
388 * and can use HTML named entities.
390 * @param $text String:
393 public static function isWellFormedXmlFragment( $text ) {
395 Sanitizer
::hackDocType() .
399 return Xml
::isWellFormed( $html );
403 * Replace " > and < with their respective HTML entities ( ",
406 * @param $in String: text that might contain HTML tags.
407 * @return string Escaped string
409 public static function escapeTagsOnly( $in ) {
411 array( '"', '>', '<' ),
412 array( '"', '>', '<' ),