svn-commit.xml

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

<refentry xml:id="function.svn-commit" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>svn_commit</refname>
  <refpurpose>Envoie les modifications depuis la copie locale vers le référentiel</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>svn_commit</methodname>
   <methodparam><type>string</type><parameter>log</parameter></methodparam>
   <methodparam><type>array</type><parameter>targets</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>recursive</parameter><initializer>&true;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Livre les modifications effectuées sur les fichiers locaux énumérés
   par le tableau <parameter>targets</parameter> dans le référentiel, avec le message
   <parameter>log</parameter>. Les dossiers contenus dans le tableau
   <parameter>targets</parameter> seront livrés récursivement tant que le
   paramètre <parameter>recursive</parameter> n'a pas été défini à &false;.
  </para>
  <note>
   <simpara>
    Cette fonction ne contient aucun paramètre spécifique à l'identification,
    aussi, le nom d'utilisateur et le mot de passe doivent être définis
    en utilisant la fonction <function>svn_auth_set_parameter</function>
   </simpara>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>log</parameter></term>
     <listitem>
      <para>
       Message d'historisation à utiliser lors de la livraison.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>targets</parameter></term>
     <listitem>
      <para>
       Tableau de chemins locaux des fichiers à livrer.
      </para>
      <warning>
       <simpara>
        Ce paramètre doit être un tableau ; une chaîne pour une
        cible unique n'est pas acceptée.
       </simpara>
      </warning>
      &svn.relativepath;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>recursive</parameter></term>
     <listitem>
      <para>
       Drapeau de type booléen pour désactiver la récursivité
       lors de la livraison de dossiers dans le tableau <parameter>targets</parameter>.
       Par défaut, vaut &true;.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>

 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne un tableau, sous la forme :
  </para>
    <screen>
<![CDATA[
array(
    0 => numéro (entier) de révision de la livraison
    1 => Date et heure (format ISO 8601) de la livraison
    2 => nom d'utilisateur de la personne ayant livré
)
]]>
    </screen>
  <para>
   Retourne &false; si une erreur survient.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple d'utilisation</title>
    <para>
     Cet exemple livre le dossier <literal>"calculator"</literal> dans le référentiel, en utilisant
     comme nom d'utilisateur <literal>"Bob"</literal> et comme mot de passe <literal>"abc123"</literal> :
    </para>
    <programlisting role="php">
<![CDATA[
<?php
svn_auth_set_parameter(SVN_AUTH_PARAM_DEFAULT_USERNAME, 'Bob');
svn_auth_set_parameter(SVN_AUTH_PARAM_DEFAULT_PASSWORD, 'abc123');
var_dump(svn_commit('Message d\'historisation de Bob', array(realpath('calculator'))));
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
array(
  0 => 1415,
  1 => '2007-05-26T01:44:28.453125Z',
  2 => 'Bob'
)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

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

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