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 foreach( $attribs as $name => $val ) {
23 $out .= ' ' . $name . '="' . Sanitizer
::encodeAttribute( $val ) . '"';
26 if( is_null( $contents ) ) {
29 if( $contents === '' ) {
32 $out .= '>' . htmlspecialchars( $contents ) . "</$element>";
39 * Format an XML element as with self::element(), but run text through the
40 * UtfNormal::cleanUp() validator first to ensure that no invalid UTF-8
43 * @param $element String:
44 * @param $attribs Array: Name=>value pairs. Values will be escaped.
45 * @param $contents String: NULL to make an open tag only; '' for a contentless closed tag (default)
48 public static function elementClean( $element, $attribs = array(), $contents = '') {
50 $attribs = array_map( array( 'UtfNormal', 'cleanUp' ), $attribs );
53 wfProfileIn( __METHOD__
. '-norm' );
54 $contents = UtfNormal
::cleanUp( $contents );
55 wfProfileOut( __METHOD__
. '-norm' );
57 return self
::element( $element, $attribs, $contents );
61 public static function openElement( $element, $attribs = null ) { return self
::element( $element, $attribs, null ); }
62 public static function closeElement( $element ) { return "</$element>"; }
65 * Same as <link>element</link>, but does not escape contents. Handy when the
66 * content you have is already valid xml.
68 public static function tags( $element, $attribs = null, $contents ) {
69 return self
::element( $element, $attribs, null ) . $contents . "</$element>";
73 * Create a namespace selector
75 * @param $selected Mixed: the namespace which should be selected, default ''
76 * @param $allnamespaces String: value of a special item denoting all namespaces. Null to not include (default)
77 * @param $includehidden Bool: include hidden namespaces?
78 * @return String: Html string containing the namespace selector
80 public static function namespaceSelector($selected = '', $allnamespaces = null, $includehidden=false) {
82 if( $selected !== '' ) {
83 if( is_null( $selected ) ) {
84 // No namespace selected; let exact match work without hitting Main
87 // Let input be numeric strings without breaking the empty match.
88 $selected = intval( $selected );
91 $s = "\n<select id='namespace' name='namespace' class='namespaceselector'>\n";
92 $arr = $wgContLang->getFormattedNamespaces();
93 if( !is_null($allnamespaces) ) {
94 $arr = array($allnamespaces => wfMsg('namespacesall')) +
$arr;
96 foreach ($arr as $index => $name) {
97 if ($index < NS_MAIN
) continue;
99 $name = $index !== 0 ?
$name : wfMsg('blanknamespace');
101 if ($index === $selected) {
102 $s .= "\t" . self
::element("option",
103 array("value" => $index, "selected" => "selected"),
106 $s .= "\t" . self
::element("option", array("value" => $index), $name) . "\n";
113 public static function span( $text, $class, $attribs=array() ) {
114 return self
::element( 'span', array( 'class' => $class ) +
$attribs, $text );
118 * Convenience function to build an HTML text input field
119 * @return string HTML
121 public static function input( $name, $size=false, $value=false, $attribs=array() ) {
122 return self
::element( 'input', array(
125 'value' => $value ) +
$attribs );
129 * Internal function for use in checkboxes and radio buttons and such.
132 public static function attrib( $name, $present = true ) {
133 return $present ?
array( $name => $name ) : array();
137 * Convenience function to build an HTML checkbox
138 * @return string HTML
140 public static function check( $name, $checked=false, $attribs=array() ) {
141 return self
::element( 'input', array_merge(
144 'type' => 'checkbox',
146 self
::attrib( 'checked', $checked ),
151 * Convenience function to build an HTML radio button
152 * @return string HTML
154 public static function radio( $name, $value, $checked=false, $attribs=array() ) {
155 return self
::element( 'input', array(
158 'value' => $value ) + self
::attrib( 'checked', $checked ) +
$attribs );
162 * Convenience function to build an HTML form label
163 * @return string HTML
165 public static function label( $label, $id ) {
166 return self
::element( 'label', array( 'for' => $id ), $label );
170 * Convenience function to build an HTML text input field with a label
171 * @return string HTML
173 public static function inputLabel( $label, $name, $id, $size=false, $value=false, $attribs=array() ) {
174 return Xml
::label( $label, $id ) .
176 self
::input( $name, $size, $value, array( 'id' => $id ) +
$attribs );
180 * Convenience function to build an HTML checkbox with a label
181 * @return string HTML
183 public static function checkLabel( $label, $name, $id, $checked=false, $attribs=array() ) {
184 return self
::check( $name, $checked, array( 'id' => $id ) +
$attribs ) .
186 self
::label( $label, $id );
190 * Convenience function to build an HTML radio button with a label
191 * @return string HTML
193 public static function radioLabel( $label, $name, $value, $id, $checked=false, $attribs=array() ) {
194 return self
::radio( $name, $value, $checked, array( 'id' => $id ) +
$attribs ) .
196 self
::label( $label, $id );
200 * Convenience function to build an HTML submit button
201 * @param $value String: label text for the button
202 * @param $attribs Array: optional custom attributes
203 * @return string HTML
205 public static function submitButton( $value, $attribs=array() ) {
206 return self
::element( 'input', array( 'type' => 'submit', 'value' => $value ) +
$attribs );
210 * Convenience function to build an HTML hidden form field.
211 * @todo Document $name parameter.
213 * @param $value String: label text for the button
214 * @param $attribs Array: optional custom attributes
215 * @return string HTML
217 public static function hidden( $name, $value, $attribs=array() ) {
218 return self
::element( 'input', array(
221 'value' => $value ) +
$attribs );
225 * Convenience function to build an HTML drop-down list item.
226 * @param $text String: text for this item
227 * @param $value String: form submission value; if empty, use text
228 * @param $selected boolean: if true, will be the default selected item
229 * @param $attribs array: optional additional HTML attributes
230 * @return string HTML
232 public static function option( $text, $value=null, $selected=false,
234 if( !is_null( $value ) ) {
235 $attribs['value'] = $value;
238 $attribs['selected'] = 'selected';
240 return self
::element( 'option', $attribs, $text );
244 * Returns an escaped string suitable for inclusion in a string literal
245 * for JavaScript source code.
246 * Illegal control characters are assumed not to be present.
248 * @param string $string
251 public static function escapeJsString( $string ) {
252 // See ECMA 262 section 7.8.4 for string literal format
260 # To avoid closing the element or CDATA section
264 # To avoid any complaints about bad entity refs
267 return strtr( $string, $pairs );
271 * Encode a variable of unknown type to JavaScript.
272 * Doesn't support hashtables just yet.
274 public static function encodeJsVar( $value ) {
275 if ( is_bool( $value ) ) {
276 $s = $value ?
'true' : 'false';
277 } elseif ( is_null( $value ) ) {
279 } elseif ( is_int( $value ) ) {
281 } elseif ( is_array( $value ) ) {
283 foreach ( $value as $name => $elt ) {
287 $s .= self
::encodeJsVar( $elt );
291 $s = '"' . self
::escapeJsString( $value ) . '"';
298 * Check if a string is well-formed XML.
299 * Must include the surrounding tag.
301 * @param $text String: string to test.
304 * @todo Error position reporting return
306 public static function isWellFormed( $text ) {
307 $parser = xml_parser_create( "UTF-8" );
309 # case folding violates XML standard, turn it off
310 xml_parser_set_option( $parser, XML_OPTION_CASE_FOLDING
, false );
312 if( !xml_parse( $parser, $text, true ) ) {
313 //$err = xml_error_string( xml_get_error_code( $parser ) );
314 //$position = xml_get_current_byte_index( $parser );
315 //$fragment = $this->extractFragment( $html, $position );
316 //$this->mXmlError = "$err at byte $position:\n$fragment";
317 xml_parser_free( $parser );
320 xml_parser_free( $parser );
325 * Check if a string is a well-formed XML fragment.
326 * Wraps fragment in an \<html\> bit and doctype, so it can be a fragment
327 * and can use HTML named entities.
329 * @param $text String:
332 public static function isWellFormedXmlFragment( $text ) {
334 Sanitizer
::hackDocType() .
338 return Xml
::isWellFormed( $html );
342 * Replace " > and < with their respective HTML entities ( ",
345 * @param $in String: text that might contain HTML tags.
346 * @return string Escaped string
348 public static function escapeTagsOnly( $in ) {
350 array( '"', '>', '<' ),
351 array( '"', '>', '<' ),