Source of: /manual/en/function.xdiff-string-bpatch.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.xdiff.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.xdiff-string-bpatch.php',
1 => 'xdiff_string_bpatch',
),
'up' =>
array (
0 => 'ref.xdiff.php',
1 => 'xdiff Functions',
),
'prev' =>
array (
0 => 'function.xdiff-string-bdiff.php',
1 => 'xdiff_string_bdiff',
),
'next' =>
array (
0 => 'function.xdiff-string-diff-binary.php',
1 => 'xdiff_string_diff_binary',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.xdiff-string-bpatch" class="refentry">
<div class="refnamediv">
<h1 class="refname">xdiff_string_bpatch</h1>
<p class="verinfo">(PECL xdiff >= 0.2.0)</p><p class="refpurpose"><span class="refname">xdiff_string_bpatch</span> — <span class="dc-title">Patch a string with a binary diff</span></p>
</div>
<a name="function.xdiff-string-bpatch.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><b>xdiff_string_bpatch</b></span>
( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$str</tt></span>
, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$patch</tt></span>
)</div>
<p class="para rdfs-comment">
Patches a string <i><tt class="parameter">str</tt></i>
with a binary <i><tt class="parameter">patch</tt></i>
.
This function accepts patches created both via <a href="function.xdiff-string-bdiff.php" class="function">xdiff_string_bdiff()</a>
and <a href="function.xdiff-string-rabdiff.php" class="function">xdiff_string_rabdiff()</a> functions or their file counterparts.
</p>
</div>
<a name="function.xdiff-string-bpatch.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">str</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The original binary string.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">patch</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The binary patch string.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.xdiff-string-bpatch.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the patched string, or <b><tt class="constant">FALSE</tt></b> on error.
</p>
</div>
<a name="function.xdiff-string-bpatch.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.xdiff-string-bdiff.php" class="function" rel="rdfs-seeAlso">xdiff_string_bdiff()</a> - Make binary diff of two strings</li>
<li class="member"><a href="function.xdiff-string-rabdiff.php" class="function" rel="rdfs-seeAlso">xdiff_string_rabdiff()</a> - Make binary diff of two strings using the Rabin's polynomial fingerprinting algorithm</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
