svn-diff.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 715a125af5a86f0e6d6d5aa6cfa9c45257a433ac Maintainer: aur Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.svn-diff" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>svn_diff</refname>
  <refpurpose>Рекурсивно показывает различия двух файлов</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>
  <para>
   Рекурсивно показывает различия двух файлов <parameter>path1</parameter> и
   <parameter>path2</parameter>.
  </para>
  <note>
   <para>
    Это не инструмент просмотра общих изменений.
    Могут быть просмотрены различия только локальных файлов,
    которые находятся в системе контроля версий SVN :
    для других файлов различия просмотреть не удастся.
   </para>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>path1</parameter></term>
     <listitem>
      <para>
       Первый путь. Это может быть URL файла/директории в репозитории SVN
       или путь к локальному файлу/директории.
      </para>
      &svn.relativepath;
      <warning>
       <simpara>
        Если путь к локальному файлу состоит только из обратных слешей (\),
        без слеша (/), данному модулю не удастся найти необходимые файлы.
        Всегда заменяйте все обратные слеши (\) на слеши (/), используя эту функцию.
       </simpara>
      </warning>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>rev1</parameter></term>
     <listitem>
      <para>
       Номер ревизии первого файла. Используйте константу <constant>SVN_REVISION_HEAD</constant>
       для задания самой последней ревизии.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>path2</parameter></term>
     <listitem>
      <para>
       Второй путь к файлу, аналогично <parameter>path1</parameter>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>rev2</parameter></term>
     <listitem>
      <para>
       Номер ревизии второго файла, аналогично <parameter>rev1</parameter>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>

 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Возвращает список массивов состоящий из двух потоков:
   первая - различия файлов; вторая - ошибки.
   Потоки могут быть прочитаны функцией <function>fread</function>.
   При ошибке возвращает &false; или &null;.
  </para>
  <para>
   По умолчанию, вывод различий будет в стандартном формате Subversion,
   но также может использоваться <link xlink:href="&url.svn.manual.externaldifftools;">
   внешним инструментом показа различий</link>, в зависимости от настройки Subversion.
  </para>
 </refsect1>

 <!-- Use when ERRORS exist
 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   When does this function throw E_* level errors, or exceptions?
  </para>
 </refsect1>
 -->

 <!-- Use when a CHANGELOG exists
 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>Enter the PHP version of change here</entry>
       <entry>Description of change</entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>
 -->

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Простой пример</title>
    <para>
     Пример ниже иллюстрирует простое использование
     данной функции и получение данных из потока.
    </para>
    <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)
 // остальный вывод diff
]]>
    </screen>
   </example>
  </para>
  <para>
   <example>
    <title>Вывод различий между двумя ревизиями одного файла</title>
    <para>
     Этот пример показывает как реализовать функцию-обёртку,
     которая позволяет пользователю просматривать различия
     между двумя ревизиями одного файла, используя внешний путь
     репозитория (стандартный синтаксис такой реализации несколько избыточен):
    </para>
    <programlisting role="php">
<![CDATA[
<?php
function svn_diff_same_item($path, $rev1, $rev2) {
    return svn_diff($path, $rev1, $path, $rev2);
}
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title>Более удобный способ вывода различий между двумя файла</title>
    <para>
     Этот пример показывает как реализовать функцию-обёртку для вывода
     различий между двумя локальными файлами, которая является переносимой
     и лишена ошибок при работе с функцией <function>realpath</function> и обратным слешем.
    </para>
    <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>
  </para>
 </refsect1>

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

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><link xlink:href="&url.svn.manual.diff;">SVN-документация по svn diff</link></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
-->