xdiff-string-diff.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 4754397753fd79f1c846868b66a2448babab1c54 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->

<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<refentry xml:id="function.xdiff-string-diff" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>xdiff_string_diff</refname>
  <refpurpose>Создать обычный патч для двух строк</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>xdiff_string_diff</methodname>
   <methodparam><type>string</type><parameter>old_data</parameter></methodparam>
   <methodparam><type>string</type><parameter>new_data</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>context</parameter><initializer>3</initializer></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>minimal</parameter><initializer>&false;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Создаёт патч для строк <parameter>old_data</parameter> и
   <parameter>new_data</parameter>. Итоговый патч человекочитаем.
   Опциональный параметр <parameter>context</parameter> указывает, сколько строк
   контекста должно быть добавлено в патч вокруг каждого различия.
   Установка параметра <parameter>minimal</parameter> в значение &true;
   позволит получить максимально короткий патч (может занять много времени).
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>old_data</parameter></term>
     <listitem>
      <para>
       Первая строка с данными. Это будут "старые" данные.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>new_data</parameter></term>
     <listitem>
      <para>
       Вторая строка с данными. Это будут "новые" данные.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>context</parameter></term>
     <listitem>
      <para>
       Количество строк контекста вокруг каждого изменения.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>minimal</parameter></term>
     <listitem>
      <para>
       Если &true;, то будет создан максимально короткий патч (может занять много времени).
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Возвращает строку с патчем, либо &false; в случае возникновения ошибки.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример использования <function>xdiff_string_diff</function></title>
    <para>
     Следующий код выведет различия двух статей.
    </para>
    <programlisting role="php">
<![CDATA[
<?php
$old_article = file_get_contents('./old_article.txt');
$new_article = $_REQUEST['article']; /* Допустим кто-то отправил новую статью через html-форму */

$diff = xdiff_string_diff($old_article, $new_article, 1);
if (is_string($diff)) {
    echo "Различия в двух статьях:\n";
    echo $diff;
}

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

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    Эта функция не предназначена для работы с бинарными данными. Для бинарного
    сравнения используйте <function>xdiff_string_bdiff</function>
    и <function>xdiff_string_rabdiff</function>.
   </para>
  </note>
 </refsect1>

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