mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-26 22:08:55 +00:00
fc9e379fd8
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@315005 c90b9560-bf6c-de11-be94-00142212c4b1
146 lines
4.1 KiB
XML
146 lines
4.1 KiB
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-string-patch" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>xdiff_string_patch</refname>
|
|
<refpurpose>Patch a string with an unified diff</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<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>
|
|
Patches a <parameter>str</parameter> string with an unified patch in <parameter>patch</parameter> parameter
|
|
and returns the result. <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. Any
|
|
rejected parts of the patch will be stored inside <parameter>error</parameter> variable if
|
|
it is provided.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>str</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The original string.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>patch</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The unified patch string. 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>flags</parameter></term>
|
|
<listitem>
|
|
<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>
|
|
Starting from version 1.5.0, you can also use binary OR to enable
|
|
<constant>XDIFF_PATCH_IGNORESPACE</constant> flag.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>error</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
If provided then rejected parts are stored inside this variable.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the patched string, or &false; on error.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<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>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>xdiff_string_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
|
|
-->
|