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

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<refentry xml:id="function.xdiff-file-patch" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>xdiff_file_patch</refname>
  <refpurpose>Patch a file with an unified diff</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</type><methodname>xdiff_file_patch</methodname>
   <methodparam><type>string</type><parameter>file</parameter></methodparam>
   <methodparam><type>string</type><parameter>patch</parameter></methodparam>
   <methodparam><type>string</type><parameter>dest</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>DIFF_PATCH_NORMAL</initializer></methodparam>
  </methodsynopsis>
  <para>
   Patches a <parameter>file</parameter> with a <parameter>patch</parameter> and stores the result in a file.
   <parameter>patch</parameter> has to be an unified diff created by 
   <function>xdiff_file_diff</function>/<function>xdiff_string_diff</function> function. 
   An optional <parameter>flags</parameter> parameter specifies mode of operation.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>file</parameter></term>
     <listitem>
      <para>
       The original file.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>patch</parameter></term>
     <listitem>
      <para>
       The unified patch file. It has to be created using <function>xdiff_string_diff</function>, 
       <function>xdiff_file_diff</function> functions or compatible tools.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>dest</parameter></term>
     <listitem>
      <para>
       Path of the resulting file.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       Can be either <constant>XDIFF_PATCH_NORMAL</constant> (default mode,
       normal patch) or <constant>XDIFF_PATCH_REVERSE</constant> (reversed
       patch).
      </para>
      <para>
       Starting from version 1.5.0, you can also use binary OR to enable
       <constant>XDIFF_PATCH_IGNORESPACE</constant> flag.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns &false; if an internal error happened, string with rejected
   chunks if patch couldn't be applied or &true; if patch has been successfully applied.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>xdiff_file_patch</function> example</title>
    <para>
     The following code applies unified diff to a file.
    </para>
    <programlisting role="php">
<![CDATA[
<?php
$old_version = 'my_script-1.0.php';
$patch = 'my_script.patch';

$errors = xdiff_file_patch($old_version, $patch, 'my_script-1.1.php');
if (is_string($errors)) {
   echo "Rejects:\n";
   echo $errors;
}

?>
]]>
    </programlisting>
   </example>
   <example>
    <title>Patch reversing example</title>
    <para>
     The following code reverses a patch.
    </para>
    <programlisting role="php">
<![CDATA[
<?php
$new_version = 'my_script-1.1.php';
$patch = 'my_script.patch';

$errors = xdiff_file_patch($new_version, $patch, 'my_script-1.0.php', XDIFF_PATCH_REVERSE);
if (is_string($errors)) {
   echo "Rejects:\n";
   echo $errors;
}

?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>xdiff_file_diff</function></member>
   </simplelist>
  </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:"~/.phpdoc/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
-->