Generating XML output - Revision history

Nicholasjohn16 at 23:37, 5 November 2011

2011-11-05T23:37:50Z

Nicholasjohn16 at 23:35, 5 November 2011

2011-11-05T23:35:55Z

Mvangeest: Adjusted category

2011-02-02T18:43:39Z

Adjusted category

Batch1211 at 20:48, 29 September 2010

2010-09-29T20:48:56Z

Chris Davenport: New page: Joomla supports a simple and quite efficient class, JSimpleXML, which can be used to generate XML output in, for example, an Ajax implementation. However, using an object-based XML ge...

2009-09-17T09:36:32Z

New page: Joomla supports a simple and quite efficient class, JSimpleXML, which can be used to generate XML output in, for example, an Ajax implementation. However, using an object-based XML ge...

New page

Joomla supports a simple and quite efficient class, [[JSimpleXML]], which can be used to generate XML output in, for example, an Ajax implementation. However, using an object-based XML generator suffers from the drawback that it tends to be slow and memory-intensive, even though [[JSimpleXML]] is a lightweight implementation. Unless your requirements are particularly complex, directly outputting XML in string form will result in faster response times and a lower server footprint.

For example, the following code will output an XML document consisting of a root element, called <root>, containing an <items> element which itself contains one or more <item> elements with the actual data. You will need to adjust the code to cope with your particular data requirements.
<source lang="php">
<?php
$document =& JFactory::getDocument();
$document->setMimeEncoding( 'text/xml' );

// Output XML header.
echo '<?xml version="1.0" encoding="UTF-8" ?>' . "\n";

// Output root element.
echo '<root>' . "\n";

// Output the data.
echo "\t" . '<items>' . "\n";
if (!empty( $data )) {
foreach ($data as $datum) {
echo "\t\t" . '<item>' . "\n";
foreach ($datum as $key => $value) {
echo "\t\t\t" . '<' . $key . '>' . htmlspecialchars( $value ) . '</' . $key . '>' . "\n";
}
echo "\t\t" . '</item>' . "\n";
}
}
echo "\t" . '</items>' . "\n";

// Terminate root element.
echo '</root>' . "\n";
</source>
Note that the data should be passed through [[php:htmlspecialchars|htmlspecialchars]] to ensure that HTML characters are properly escaped.

Note also that in this example some attempt has been made to "pretty print" the XML output with tabs and carriage returns. This is not strictly necessary and these extra characters can be removed if you prefer.
<noinclude>[[Category:Development]]</noinclude>

@@ Line 32: / Line 32: @@
 Note also that in this example some attempt has been made to "pretty print" the XML output with tabs and carriage returns.  This is not strictly necessary and these extra characters can be removed if you prefer.
-<noinclude>[[Category:Development]]</noinclude>[[Category:Tutorials]][[Category:Template Development]]
+<noinclude>[[Category:Development]][[Category:Tutorials]]</noinclude>
-[[Category:Module Development]]
-[[Category:Plugin Development]]
-[[Category:Component Development]]

← Older revision		Revision as of 20:48, 29 September 2010
Line 32:		Line 32:

	Note also that in this example some attempt has been made to "pretty print" the XML output with tabs and carriage returns. This is not strictly necessary and these extra characters can be removed if you prefer.		Note also that in this example some attempt has been made to "pretty print" the XML output with tabs and carriage returns. This is not strictly necessary and these extra characters can be removed if you prefer.
−	<noinclude>[[Category:Development]]</noinclude>	+	<noinclude>[[Category:Development]]</noinclude>[[Category:Tutorials]][[Category:Template Development]]
		+	[[Category:Module Development]]
		+	[[Category:Plugin Development]]
		+	[[Category:Component Development]]

@@ Line 11: / Line 11: @@
 // Output root element.
-echo '<root>' . "\n";
+echo '<root>'."\n";
 // Output the data.
-echo "\t" . '<items>' . "\n";
+echo "\t".'<items>'."\n";
-if (!empty( $data )) {
+if(!empty($data)){
-	foreach ($data as $datum) {
+     foreach($data as $datum){
-		echo "\t\t" . '<item>' . "\n";
+          echo "\t\t".'<item>'."\n";
-		foreach ($datum as $key => $value) {
+          foreach ($datum as $key => $value) {
-			echo "\t\t\t".'<'.$key.'>'.htmlspecialchars($value).'</'.$key.'>'."\n";
+               echo "\t\t\t".'<'.$key.'>'.htmlspecialchars($value).'</'.$key.'>'."\n";
-−
+          }
-		echo "\t\t" . '</item>' . "\n";
+          echo "\t\t".'</item>'."\n";
-−
+     }
+}
-echo "\t" . '</items>' . "\n";
+echo "\t".'</items>'."\n";
 // Terminate root element.
-echo '</root>' . "\n";
+echo '</root>'."\n";
 </source>
 Note that the data should be passed through [[php:htmlspecialchars|htmlspecialchars]] to ensure that HTML characters are properly escaped.