php-doc-en/reference/xdiff/functions/xdiff-file-patch.xml
Jakub Vrana a1ddba3e96 rtrim($refpurpose, '.')
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@166882 c90b9560-bf6c-de11-be94-00142212c4b1
2004-08-20 09:37:01 +00:00

102 lines
2.8 KiB
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-file-patch">
<refnamediv>
<refname>xdiff_file_patch</refname>
<refpurpose>
Patch a file with an unified diff
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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></methodparam>
</methodsynopsis>
<para>
<function>xdiff_file_patch</function> patches file
<parameter>file</parameter> with unified patch in file
<parameter>patch</parameter> and stores result in file
<parameter>dest</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>
Returns &false; if an internal error happened, string with rejected
chunks of patch or &true; if patch has been successfully applied.
</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>
See also <function>xdiff_string_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
-->