doc-fr/reference/xdiff/functions/xdiff-string-diff.xml

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

<refentry xml:id="function.xdiff-string-diff" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>xdiff_string_diff</refname>
  <refpurpose>Créé un diff unifié entre deux chaînes</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>
   Crée un diff unifié contenant les différences entre la chaîne
   <parameter>old_data</parameter> et la chaîne <parameter>new_data</parameter>
   et retourne le diff ainsi créé. Le diff résultant est humainement lisible.
   Le paramètre optionnel <parameter>context</parameter> spécifie le nombre de
   lignes de contexte à ajouter autour de chaque modification. Le fait de définir
   le paramètre <parameter>minimal</parameter> à &true; fera que le diff sera le
   plus petit possible (peut prendre du temps).
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>old_data</parameter></term>
     <listitem>
      <para>
       Première chaîne de données. Ce sont les anciennes données.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>new_data</parameter></term>
     <listitem>
      <para>
       Seconde chaîne de données. Ce sont les nouvelles données.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>context</parameter></term>
     <listitem>
      <para>
       Indique le nombre de lignes de contexte que vous voulez inclure
       dans le diff résultant.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>minimal</parameter></term>
     <listitem>
      <para>
       Configurez <parameter>minimal</parameter> à &true; si vous voulez
       minimaliser la taille du diff (peut prendre beaucoup de temps).
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne une chaîne représentant le diff résultant, ou &false; si une erreur
   interne survient.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>xdiff_string_diff</function></title>
    <para>
     Le code suivant effectue un diff de deux articles.
    </para>
    <programlisting role="php">
<![CDATA[
<?php
$old_article = file_get_contents('./old_article.txt');
$new_article = $_REQUEST['article']; /* disons que quelqu'un a posté un nouvel article via un formulaire html */

$diff = xdiff_string_diff($old_article, $new_article, 1);
if (is_string($diff)) {
    echo "Différences entre les deux articles :\n";
    echo $diff;
}

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

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    Cette fonction ne fonctionne pas correctement avec des chaînes binaires.
    Pour effectuer un diff de chaînes binaires, utilisez la fonction
    <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
-->