<!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>Canonicalize nodes to a file</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="domnode.c14n.html">DOMNode::C14N</a></div>
<div class="next" style="text-align: right; float: right;"><a href="domnode.clonenode.html">DOMNode::cloneNode</a></div>
<div class="up"><a href="class.domnode.html">DOMNode</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="domnode.c14nfile" class="refentry">
<div class="refnamediv">
<h1 class="refname">DOMNode::C14NFile</h1>
<p class="verinfo">(PHP 5 >= 5.2.0)</p><p class="refpurpose"><span class="refname">DOMNode::C14NFile</span> — <span class="dc-title">Canonicalize nodes to a file</span></p>
</div>
<div class="refsect1 description" id="refsect1-domnode.c14nfile-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>DOMNode::C14NFile</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$uri</code></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$exclusive</code></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$with_comments</code></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$xpath</code></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$ns_prefixes</code></span>
]]]] )</div>
<p class="para rdfs-comment">
Canonicalize nodes to a file.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-domnode.c14nfile-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<span class="term"><em><code class="parameter">uri</code></em></span>
<dd>
<p class="para">
Path to write the output to.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">exclusive</code></em></span>
<dd>
<p class="para">
Enable exclusive parsing of only the nodes matched by the provided
xpath or namespace prefixes.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">with_comments</code></em></span>
<dd>
<p class="para">
Retain comments in output.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">xpath</code></em></span>
<dd>
<p class="para">
An array of <em>xpath</em>s to filter the nodes by.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">ns_prefixes</code></em></span>
<dd>
<p class="para">
An array of namespace prefixes to filter the nodes by.
</p>
</dd>
</dt>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-domnode.c14nfile-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Number of bytes written or <strong><code>FALSE</code></strong> on failure
</p>
</div>
<div class="refsect1 seealso" id="refsect1-domnode.c14nfile-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="domnode.c14n.html" class="methodname" rel="rdfs-seeAlso">DOMNode::C14N()</a> - Canonicalize nodes to 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="domnode.c14n.html">DOMNode::C14N</a></div>
<div class="next" style="text-align: right; float: right;"><a href="domnode.clonenode.html">DOMNode::cloneNode</a></div>
<div class="up"><a href="class.domnode.html">DOMNode</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
