php-doc-en/reference/xdiff/functions/xdiff-string-patch.xml

<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.5 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
  <refentry id="function.xdiff-string-patch">
   <refnamediv>
    <refname>xdiff_string_patch</refname>
    <refpurpose>
     Patch a string with an unified diff
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <methodsynopsis>
     <type>string</type><methodname>xdiff_string_patch</methodname>
     <methodparam><type>string</type><parameter>str</parameter></methodparam>
     <methodparam><type>string</type><parameter>patch</parameter></methodparam>
     <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
     <methodparam choice="opt"><type>string</type><parameter role="reference">error</parameter></methodparam>
    </methodsynopsis>
    <para>
     <function>xdiff_string_patch</function> patches string
     <parameter>str</parameter> with unified patch in string 
     <parameter>patch</parameter>.
    </para>
    <para>
     <parameter>flags</parameter> can be either
     <constant>XDIFF_PATCH_NORMAL</constant> (default mode, normal patch) or 
     <constant>XDIFF_PATCH_REVERSE</constant> (reversed patch).
    </para>
    <para>
     If <parameter>error</parameter> is passed then rejected parts are stored
     inside this variable.
    </para>
    <example>
     <title><function>xdiff_string_patch</function> example</title>
     <para>
      The following code applies changes to some article.
     </para>
     <programlisting role="php">
<![CDATA[
<?php
$old_article = file_get_contents('./old_article.txt');
$diff = $_SERVER['patch']; /* Let's say that someone pasted a patch to html form */

$errors = '';

$new_article = xdiff_string_patch($old_article, $diff, XDIFF_PATCH_NORMAL, $errors);
if (is_string($new_article)) {
    echo "New article:\n";
    echo $new_article;
}

if (strlen($errors)) {
    echo "Rejects: \n";
    echo $errors;
}

?>
]]>
     </programlisting>
    </example>
    <para>
     Returns a patched string.
    </para>
    <para>
     See also <function>xdiff_file_patch</function>.
    </para>
   </refsect1>
  </refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->