<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Return a well-formed XML string based on SimpleXML element</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="simplexmlelement.addchild.html">SimpleXMLElement::addChild</a></div>
<div class="next" style="text-align: right; float: right;"><a href="simplexmlelement.attributes.html">SimpleXMLElement::attributes</a></div>
<div class="up"><a href="class.simplexmlelement.html">SimpleXMLElement</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="simplexmlelement.asxml" class="refentry">
<div class="refnamediv">
<h1 class="refname">SimpleXMLElement::asXML</h1>
<p class="verinfo">(PHP 5 >= 5.0.1)</p><p class="refpurpose"><span class="refname">SimpleXMLElement::asXML</span> — <span class="dc-title">
Return a well-formed XML string based on SimpleXML element
</span></p>
</div>
<div class="refsect1 description" id="refsect1-simplexmlelement.asxml-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><strong>SimpleXMLElement::asXML</strong></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$filename</code></span>
] )</div>
<p class="para rdfs-comment">
The <em>asXML</em> method formats the parent object's data
in XML version 1.0.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-simplexmlelement.asxml-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">filename</code></em></span>
<dd>
<p class="para">
If specified, the function writes the data to the file rather than
returning it.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-simplexmlelement.asxml-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
If the <em><code class="parameter">filename</code></em> isn't specified, this function
returns a <span class="type"><a href="language.types.string.html" class="type string">string</a></span> on success and <strong><code>FALSE</code></strong> on error. If the
parameter is specified, it returns <strong><code>TRUE</code></strong> if the file was written
successfully and <strong><code>FALSE</code></strong> otherwise.
</p>
</div>
<div class="refsect1 examples" id="refsect1-simplexmlelement.asxml-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-5498">
<p><strong>Example #1 Get XML</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$string </span><span style="color: #007700">= <<<XML<br /></span><span style="color: #DD0000"><a><br /> <b><br /> <c>text</c><br /> <c>stuff</c><br /> </b><br /> <d><br /> <c>code</c><br /> </d><br /></a><br /></span><span style="color: #007700">XML;<br /><br /></span><span style="color: #0000BB">$xml </span><span style="color: #007700">= new </span><span style="color: #0000BB">SimpleXMLElement</span><span style="color: #007700">(</span><span style="color: #0000BB">$string</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #0000BB">$xml</span><span style="color: #007700">-></span><span style="color: #0000BB">asXML</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
<?xml version="1.0"?>
<a>
<b>
<c>text</c>
<c>stuff</c>
</b>
<d>
<c>code</c>
</d>
</a>
</pre></div>
</div>
</div>
</p>
<p class="para">
<em>asXML</em> also works on Xpath results:
<div class="example" id="example-5499">
<p><strong>Example #2 Using asXML() on <span class="methodname"><a href="simplexmlelement.xpath.html" class="methodname">SimpleXMLElement::xpath()</a></span> results</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// Continued from example XML above.<br /><br />/* Search for <a><b><c> */<br /></span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">$xml</span><span style="color: #007700">-></span><span style="color: #0000BB">xpath</span><span style="color: #007700">(</span><span style="color: #DD0000">'/a/b/c'</span><span style="color: #007700">);<br /><br />while(list( , </span><span style="color: #0000BB">$node</span><span style="color: #007700">) = </span><span style="color: #0000BB">each</span><span style="color: #007700">(</span><span style="color: #0000BB">$result</span><span style="color: #007700">)) {<br /> echo </span><span style="color: #0000BB">$node</span><span style="color: #007700">-></span><span style="color: #0000BB">asXML</span><span style="color: #007700">();<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
<c>text</c><c>stuff</c>
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-simplexmlelement.asxml-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="simplexmlelement.tostring.html" class="methodname" rel="rdfs-seeAlso">SimpleXMLElement::__toString()</a> - Returns the string content</span></li>
<li class="member"><a href="simplexml.examples-basic.html" class="xref">Basic SimpleXML usage</a></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="simplexmlelement.addchild.html">SimpleXMLElement::addChild</a></div>
<div class="next" style="text-align: right; float: right;"><a href="simplexmlelement.attributes.html">SimpleXMLElement::attributes</a></div>
<div class="up"><a href="class.simplexmlelement.html">SimpleXMLElement</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
