File: xdiff-file-patch.xml

package info (click to toggle)
php-doc 20061001-1
  • links: PTS
  • area: non-free
  • in suites: etch, etch-m68k
  • size: 45,764 kB
  • ctags: 1,611
  • sloc: xml: 502,485; php: 7,645; cpp: 500; makefile: 297; perl: 161; sh: 141; awk: 28
file content (102 lines) | stat: -rw-r--r-- 2,905 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
<?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
-->