archived-doc-fr/reference/svn/functions/svn-diff.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 997700a58795b985b5d906dd989a4f01790e4d4f Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.svn-diff">
 <refnamediv>
  <refname>svn_diff</refname>
  <refpurpose>Compare deux chemins, récursivement</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>svn_diff</methodname>
   <methodparam><type>string</type><parameter>path1</parameter></methodparam>
   <methodparam><type>int</type><parameter>rev1</parameter></methodparam>
   <methodparam><type>string</type><parameter>path2</parameter></methodparam>
   <methodparam><type>int</type><parameter>rev2</parameter></methodparam>
  </methodsynopsis>
  <simpara>
   Compare deux chemins, <parameter>path1</parameter> et
   <parameter>path2</parameter>, récursivement.
  </simpara>
  <note>
   <simpara>
    Ce n'est pas un véritable utilitaire de comparaison. Seuls les fichiers
    locaux qui sont versionnés peuvent être comparés : les autres fichiers
    échoueront.
   </simpara>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>path1</parameter></term>
    <listitem>
     <simpara>
      Premier chemin. Peut être une URL vers un fichier/dossier d'un
      référentiel SVN ou un chemin vers un fichier/dossier local.
     </simpara>
     &svn.relativepath;
     <warning>
      <simpara>
       Si un chemin vers un fichier local n'a que des antislashs et aucun
       slashs, cette extension échouera. Remplacer toujours tous les
       antislashs avec des slashs lors de l'utilisation de cette fonction.
      </simpara>
     </warning>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>rev1</parameter></term>
    <listitem>
     <simpara>
      Numéro de révision du premier chemin. Utiliser la constante
      <constant>SVN_REVISON_HEAD</constant> pour spécifier la révision
      la plus récente.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>path2</parameter></term>
    <listitem>
     <simpara>
      Deuxième chemin à comparer. Voir le paramètre
      <parameter>path1</parameter> pour la description.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>rev2</parameter></term>
    <listitem>
     <simpara>
      Numéro de révision du second chemin. Voir le paramètre
      <parameter>rev1</parameter> pour la description.
     </simpara>
    </listitem>
   </varlistentry>
  </variablelist>

 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <simpara>
   Retourne un tableau contenant 2 flux : le premier représente la sortie
   de la comparaison, et le second contient les erreurs. Les flux peuvent
   être lus en utilisant la fonction <function>fread</function>. Retourne
   &false; ou &null; si une erreur survient.
  </simpara>
  <simpara>
   La sortie du comparateur peut, par défaut, être au format de comparaison
   unifié Subversion, mais un
   <link xlink:href="&url.svn.manual.externaldifftools;">moteur externe de
    comparaison</link> peut être utilisé, suivant la configuration SVN.
  </simpara>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Exemple d'utilisation</title>
   <simpara>
    Cet exemple montre une utilisation basique de cette fonction et récupère
    le contenu depuis les flux :
   </simpara>
   <programlisting role="php">
<![CDATA[
<?php
list($diff, $errors) = svn_diff(
    'http://www.example.com/svnroot/trunk/foo', SVN_REVISION_HEAD,
    'http://www.example.com/svnroot/branches/dev/foo', SVN_REVISION_HEAD
);
if (!$diff) exit;
$contents = '';
while (!feof($diff)) {
  $contents .= fread($diff, 8192);
}
fclose($diff);
fclose($errors);
var_dump($contents);
?>
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
Index: http://www.example.com/svnroot/trunk/foo
===================================================================
--- http://www.example.com/svnroot/trunk/foo        (.../foo) (revision 23)
+++ http://www.example.com/svnroot/branches/dev/foo (.../foo) (revision 27)
 // further diff output
]]>
   </screen>
  </example>
  <example>
   <title>Comparaison de deux révisions d'un chemin du référentiel</title>
   <simpara>
    Cet exemple implémente un gestionnaire permettant
    à un utilisateur de comparer facilement deux révisions d'un élément
    en utilisant un chemin de référentiel externe (la syntaxe par défaut est verbeuse) :
   </simpara>
   <programlisting role="php">
<![CDATA[
<?php
function svn_diff_same_item($path, $rev1, $rev2) {
    return svn_diff($path, $rev1, $path, $rev2);
}
?>
]]>
   </programlisting>
  </example>
  <example>
   <title>Comparaison, plus portable, de deux fichiers locaux</title>
   <simpara>
    Cet exemple implémente un gestionnaire permettant de comparer
    deux fichiers locaux, de façon plus portable en gérant le problème de
    <function>realpath</function> et le bogue sur les antislashs :
   </simpara>
   <programlisting role="php">
<![CDATA[
<?php
function svn_diff_local($path1, $rev1, $path2, $rev2) {
    $path1 = str_replace('\\', '/', realpath($path1));
    $path2 = str_replace('\\', '/', realpath($path2));
    return svn_diff($path1, $rev1, $path2, $rev2);
}
?>
]]>
   </programlisting>
  </example>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  &warn.experimental.func;
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><link xlink:href="&url.svn.manual.diff;">Documentation SVN sur la commande <literal>"svn diff"</literal></link></member>
  </simplelist>
 </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
-->