<!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>Patch a string with an unified diff</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.xdiff-string-patch-binary.html">xdiff_string_patch_binary</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.xdiff-string-rabdiff.html">xdiff_string_rabdiff</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-string-patch" class="refentry">
<div class="refnamediv">
<h1 class="refname">xdiff_string_patch</h1>
<p class="verinfo">(PECL xdiff >= 0.2.0)</p><p class="refpurpose"><span class="refname">xdiff_string_patch</span> — <span class="dc-title">Patch a string with an unified diff</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.xdiff-string-patch-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>xdiff_string_patch</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$str</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$patch</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$flags</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter reference">&$error</code></span>
]] )</div>
<p class="para rdfs-comment">
Patches a <em><code class="parameter">str</code></em> string with an unified patch in <em><code class="parameter">patch</code></em> parameter
and returns the result. <em><code class="parameter">patch</code></em> has to be an unified diff created by
<span class="function"><a href="function.xdiff-file-diff.html" class="function">xdiff_file_diff()</a></span>/ <span class="function"><a href="function.xdiff-string-diff.html" class="function">xdiff_string_diff()</a></span> function.
An optional <em><code class="parameter">flags</code></em> parameter specifies mode of operation. Any
rejected parts of the patch will be stored inside <em><code class="parameter">error</code></em> variable if
it is provided.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.xdiff-string-patch-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">str</code></em></span>
<dd>
<p class="para">
The original string.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">patch</code></em></span>
<dd>
<p class="para">
The unified patch string. It has to be created using <span class="function"><a href="function.xdiff-string-diff.html" class="function">xdiff_string_diff()</a></span>,
<span class="function"><a href="function.xdiff-file-diff.html" class="function">xdiff_file_diff()</a></span> functions or compatible tools.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">flags</code></em></span>
<dd>
<p class="para">
<em><code class="parameter">flags</code></em> can be either
<strong><code>XDIFF_PATCH_NORMAL</code></strong> (default mode, normal patch)
or <strong><code>XDIFF_PATCH_REVERSE</code></strong> (reversed patch).
</p>
<p class="para">
Starting from version 1.5.0, you can also use binary OR to enable
<strong><code>XDIFF_PATCH_IGNORESPACE</code></strong> flag.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">error</code></em></span>
<dd>
<p class="para">
If provided then rejected parts are stored inside this variable.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.xdiff-string-patch-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the patched string, or <strong><code>FALSE</code></strong> on error.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.xdiff-string-patch-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2461">
<p><strong>Example #1 <span class="function"><strong>xdiff_string_patch()</strong></span> example</strong></p>
<div class="example-contents"><p>
The following code applies changes to some article.
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$old_article </span><span style="color: #007700">= </span><span style="color: #0000BB">file_get_contents</span><span style="color: #007700">(</span><span style="color: #DD0000">'./old_article.txt'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$diff </span><span style="color: #007700">= </span><span style="color: #0000BB">$_SERVER</span><span style="color: #007700">[</span><span style="color: #DD0000">'patch'</span><span style="color: #007700">]; </span><span style="color: #FF8000">/* Let's say that someone pasted a patch to html form */<br /><br /></span><span style="color: #0000BB">$errors </span><span style="color: #007700">= </span><span style="color: #DD0000">''</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$new_article </span><span style="color: #007700">= </span><span style="color: #0000BB">xdiff_string_patch</span><span style="color: #007700">(</span><span style="color: #0000BB">$old_article</span><span style="color: #007700">, </span><span style="color: #0000BB">$diff</span><span style="color: #007700">, </span><span style="color: #0000BB">XDIFF_PATCH_NORMAL</span><span style="color: #007700">, </span><span style="color: #0000BB">$errors</span><span style="color: #007700">);<br />if (</span><span style="color: #0000BB">is_string</span><span style="color: #007700">(</span><span style="color: #0000BB">$new_article</span><span style="color: #007700">)) {<br /> echo </span><span style="color: #DD0000">"New article:\n"</span><span style="color: #007700">;<br /> echo </span><span style="color: #0000BB">$new_article</span><span style="color: #007700">;<br />}<br /><br />if (</span><span style="color: #0000BB">strlen</span><span style="color: #007700">(</span><span style="color: #0000BB">$errors</span><span style="color: #007700">)) {<br /> echo </span><span style="color: #DD0000">"Rejects: \n"</span><span style="color: #007700">;<br /> echo </span><span style="color: #0000BB">$errors</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.xdiff-string-patch-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.xdiff-string-diff.html" class="function" rel="rdfs-seeAlso">xdiff_string_diff()</a> - Make unified diff of two strings</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-string-patch-binary.html">xdiff_string_patch_binary</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.xdiff-string-rabdiff.html">xdiff_string_rabdiff</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>
