svn-cat.xml

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

<refentry xml:id="function.svn-cat" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>svn_cat</refname>
  <refpurpose>Récupère le contenu d'un fichier du référentiel</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>svn_cat</methodname>
   <methodparam><type>string</type><parameter>repos_url</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>revision_no</parameter></methodparam>
  </methodsynopsis>
  <para>
   Récupère le contenu du fichier pointé par l'URL <parameter>repos_url</parameter>
   du référentiel, optionnellement, à la révision <parameter>revision_no</parameter>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>repos_url</parameter></term>
     <listitem>
      <para>
       URL de l'élément du référentiel.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>revision_no</parameter></term>
     <listitem>
      <para>
       Numéro de révision de l'élément à récupérer ; par défaut, vaut HEAD.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>

 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne le contenu de l'élément depuis le référentiel en cas de succès,
   et &false; si une erreur survient.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple d'utilisation</title>
    <para>
     Cet exemple récupère le contenu d'un fichier, à la révision 28 :
    </para>
    <programlisting role="php">
<![CDATA[
<?php
$contents = svn_cat('http://www.example.com/svnroot/calc/gui.c', 28)
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

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

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