<!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>Dumps the internal XML tree back into a file</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="domdocument.relaxngvalidatesource.html">DOMDocument::relaxNGValidateSource</a></div>
<div class="next" style="text-align: right; float: right;"><a href="domdocument.savehtml.html">DOMDocument::saveHTML</a></div>
<div class="up"><a href="class.domdocument.html">DOMDocument</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="domdocument.save" class="refentry">
<div class="refnamediv">
<h1 class="refname">DOMDocument::save</h1>
<p class="verinfo">(PHP 5)</p><p class="refpurpose"><span class="refname">DOMDocument::save</span> — <span class="dc-title">
Dumps the internal XML tree back into a file
</span></p>
</div>
<div class="refsect1 description" id="refsect1-domdocument.save-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><strong>DOMDocument::save</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$filename</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$options</code></span>
] )</div>
<p class="para rdfs-comment">
Creates an XML document from the DOM representation. This function is usually
called after building a new dom document from scratch as in the example below.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-domdocument.save-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">
The path to the saved XML document.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">options</code></em></span>
<dd>
<p class="para">
Additional Options. Currently only <a href="libxml.constants.html" class="link">LIBXML_NOEMPTYTAG</a> is supported.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-domdocument.save-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the number of bytes written or <strong><code>FALSE</code></strong> if an error occurred.
</p>
</div>
<div class="refsect1 changelog" id="refsect1-domdocument.save-changelog">
<h3 class="title">Changelog</h3>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>5.1.0</td>
<td>
Added the <em><code class="parameter">options</code></em> parameter
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 examples" id="refsect1-domdocument.save-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-5414">
<p><strong>Example #1 Saving a DOM tree into a file</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$doc </span><span style="color: #007700">= new </span><span style="color: #0000BB">DOMDocument</span><span style="color: #007700">(</span><span style="color: #DD0000">'1.0'</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">// we want a nice output<br /></span><span style="color: #0000BB">$doc</span><span style="color: #007700">-></span><span style="color: #0000BB">formatOutput </span><span style="color: #007700">= </span><span style="color: #0000BB">true</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$root </span><span style="color: #007700">= </span><span style="color: #0000BB">$doc</span><span style="color: #007700">-></span><span style="color: #0000BB">createElement</span><span style="color: #007700">(</span><span style="color: #DD0000">'book'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$root </span><span style="color: #007700">= </span><span style="color: #0000BB">$doc</span><span style="color: #007700">-></span><span style="color: #0000BB">appendChild</span><span style="color: #007700">(</span><span style="color: #0000BB">$root</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$title </span><span style="color: #007700">= </span><span style="color: #0000BB">$doc</span><span style="color: #007700">-></span><span style="color: #0000BB">createElement</span><span style="color: #007700">(</span><span style="color: #DD0000">'title'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$title </span><span style="color: #007700">= </span><span style="color: #0000BB">$root</span><span style="color: #007700">-></span><span style="color: #0000BB">appendChild</span><span style="color: #007700">(</span><span style="color: #0000BB">$title</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$text </span><span style="color: #007700">= </span><span style="color: #0000BB">$doc</span><span style="color: #007700">-></span><span style="color: #0000BB">createTextNode</span><span style="color: #007700">(</span><span style="color: #DD0000">'This is the title'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$text </span><span style="color: #007700">= </span><span style="color: #0000BB">$title</span><span style="color: #007700">-></span><span style="color: #0000BB">appendChild</span><span style="color: #007700">(</span><span style="color: #0000BB">$text</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #DD0000">'Wrote: ' </span><span style="color: #007700">. </span><span style="color: #0000BB">$doc</span><span style="color: #007700">-></span><span style="color: #0000BB">save</span><span style="color: #007700">(</span><span style="color: #DD0000">"/tmp/test.xml"</span><span style="color: #007700">) . </span><span style="color: #DD0000">' bytes'</span><span style="color: #007700">; </span><span style="color: #FF8000">// Wrote: 72 bytes<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-domdocument.save-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="domdocument.savexml.html" class="methodname" rel="rdfs-seeAlso">DOMDocument::saveXML()</a> - Dumps the internal XML tree back into a string</span></li>
<li class="member"> <span class="methodname"><a href="domdocument.load.html" class="methodname" rel="rdfs-seeAlso">DOMDocument::load()</a> - Load XML from a file</span></li>
<li class="member"> <span class="methodname"><a href="domdocument.loadxml.html" class="methodname" rel="rdfs-seeAlso">DOMDocument::loadXML()</a> - Load XML from a string</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="domdocument.relaxngvalidatesource.html">DOMDocument::relaxNGValidateSource</a></div>
<div class="next" style="text-align: right; float: right;"><a href="domdocument.savehtml.html">DOMDocument::saveHTML</a></div>
<div class="up"><a href="class.domdocument.html">DOMDocument</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
