<!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>Make unified diff of two files</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.xdiff-file-diff-binary.html">xdiff_file_diff_binary</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.xdiff-file-merge3.html">xdiff_file_merge3</a></div>
<div class="up"><a href="ref.xdiff.html">xdiff Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.xdiff-file-diff" class="refentry">
<div class="refnamediv">
<h1 class="refname">xdiff_file_diff</h1>
<p class="verinfo">(PECL xdiff >= 0.2.0)</p><p class="refpurpose"><span class="refname">xdiff_file_diff</span> — <span class="dc-title">Make unified diff of two files</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.xdiff-file-diff-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>xdiff_file_diff</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$old_file</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$new_file</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$dest</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$context</code><span class="initializer"> = 3</span></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$minimal</code><span class="initializer"> = false</span></span>
]] )</div>
<p class="para rdfs-comment">
Makes an unified diff containing differences between <em><code class="parameter">old_file</code></em> and
<em><code class="parameter">new_file</code></em> and stores it in <em><code class="parameter">dest</code></em> file. The
resulting file is human-readable. An optional <em><code class="parameter">context</code></em> parameter
specifies how many lines of context should be added around each change.
Setting <em><code class="parameter">minimal</code></em> parameter to true will result in outputting the shortest
patch file possible (can take a long time).
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.xdiff-file-diff-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">old_file</code></em></span>
<dd>
<p class="para">
Path to the first file. This file acts as "old" file.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">new_file</code></em></span>
<dd>
<p class="para">
Path to the second file. This file acts as "new" file.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">dest</code></em></span>
<dd>
<p class="para">
Path of the resulting patch file.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">context</code></em></span>
<dd>
<p class="para">
Indicates how many lines of context you want to include in diff
result.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">minimal</code></em></span>
<dd>
<p class="para">
Set this parameter to <strong><code>TRUE</code></strong> if you want to minimalize size of the result
(can take a long time).
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.xdiff-file-diff-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.xdiff-file-diff-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2453">
<p><strong>Example #1 <span class="function"><strong>xdiff_file_diff()</strong></span> example</strong></p>
<div class="example-contents"><p>
The following code makes unified diff of two php files with context length of 2.
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$old_version </span><span style="color: #007700">= </span><span style="color: #DD0000">'my_script.php'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$new_version </span><span style="color: #007700">= </span><span style="color: #DD0000">'my_new_script.php'</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">xdiff_file_diff</span><span style="color: #007700">(</span><span style="color: #0000BB">$old_version</span><span style="color: #007700">, </span><span style="color: #0000BB">$new_version</span><span style="color: #007700">, </span><span style="color: #DD0000">'my_script.diff'</span><span style="color: #007700">, </span><span style="color: #0000BB">2</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.xdiff-file-diff-notes">
<h3 class="title">Notes</h3>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
This function doesn't work well with binary files. To make diff of binary
files use <span class="function"><a href="function.xdiff-file-bdiff.html" class="function">xdiff_file_bdiff()</a></span>/ <span class="function"><a href="function.xdiff-file-rabdiff.html" class="function">xdiff_file_rabdiff()</a></span> function.
</p>
</p></blockquote>
</div>
<div class="refsect1 seealso" id="refsect1-function.xdiff-file-diff-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.xdiff-file-patch.html" class="function" rel="rdfs-seeAlso">xdiff_file_patch()</a> - Patch a file with an unified diff</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="function.xdiff-file-diff-binary.html">xdiff_file_diff_binary</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.xdiff-file-merge3.html">xdiff_file_merge3</a></div>
<div class="up"><a href="ref.xdiff.html">xdiff Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
