[PHP-DOC] cvs: phpdoc /fr/functions mcal.xml

[Damien Seguy]

dams            Thu Feb 22 03:04:28 2001 EDT

  Modified files:              
    /phpdoc/fr/functions        mcal.xml 
  Log:
  Added recur_type list
  
Index: phpdoc/fr/functions/mcal.xml
diff -u phpdoc/fr/functions/mcal.xml:1.7 phpdoc/fr/functions/mcal.xml:1.8
--- phpdoc/fr/functions/mcal.xml:1.7    Wed Feb  7 01:16:52 2001
+++ phpdoc/fr/functions/mcal.xml        Thu Feb 22 03:04:28 2001
@@ -3,39 +3,41 @@
   <titleabbrev>MCAL</titleabbrev>
   <partintro>
    <para>
-     MCAL signifie Modular Calendar Access Library (librairie calendaire modulaire).
+    MCAL signifie Modular Calendar Access Library (librairie calendaire modulaire).
    </para>
    <para>
-     Libmcal est une librairie C de calendriers. Elle est &eacute;crite
-     pour &ecirc;tre tr&egrave;s modulaire, et dispose de nombreux modules.
-     MCAL est l'&eacute;quivalent de <acronym>IMAP</acronym> pour les
-     calendriers.
+    Libmcal est une librairie C de calendriers. Elle est &eacute;crite
+    pour &ecirc;tre tr&egrave;s modulaire, et dispose de nombreux modules.
+    MCAL est l'&eacute;quivalent de <acronym>IMAP</acronym> pour les
+    calendriers.
    </para>
    <para>
-     Avec mcal, un calendrier peut &ecirc;tre ouvert comme une bo&icirc;te
-     aux lettres. Les calendriers peuvent &ecirc;tre des fichiers locaux,
-     ou bien &ecirc;tre sur des serveurs ICAP distants, ou encore tout
-     autre format support&eacute; par la librairie.
+    Avec mcal, un calendrier peut &ecirc;tre ouvert comme une bo&icirc;te
+    aux lettres. Les calendriers peuvent &ecirc;tre des fichiers locaux,
+    ou bien &ecirc;tre sur des serveurs ICAP distants, ou encore tout
+    autre format support&eacute; par la librairie.
    </para>
    <para>
-     Les &eacute;v&eacute;nements peuvent &ecirc;tre lus, selectionn&eacute;s
-     et enregistr&eacute;s. Il y a aussi la possibilit&eacute; d'ajouter des
-     alarmes, et de placer des &eacute;v&eacute;n&eacute;ments r&eacute;curents.
+    Les &eacute;v&eacute;nements peuvent &ecirc;tre lus, selectionn&eacute;s
+    et enregistr&eacute;s. Il y a aussi la possibilit&eacute; d'ajouter des
+    alarmes, et de placer des &eacute;v&eacute;n&eacute;ments r&eacute;curents.
    </para>
    <para>
-     Avec libmcal, les serveurs centralis&eacute;s peuvent &ecirc;tre
-     acc&eacute;d&eacute;s et utilis&eacute;s, et remplacent avantageusement
-     tout d&eacute;veloppement sp&eacute;cifique de base de donn&eacute;es.
+    Avec libmcal, les serveurs centralis&eacute;s peuvent &ecirc;tre
+    acc&eacute;d&eacute;s et utilis&eacute;s, et remplacent avantageusement
+    tout d&eacute;veloppement sp&eacute;cifique de base de donn&eacute;es.
    </para>
    <para>
-     Pour faire fonctionner cette librairie, vous devez compiler PHP avec
-     l'option <option role="configure">--with-mcal</option>. Il vous faudra
-     alors avoir install&eacute; la librairie mcal. T&eacute;l&eacute;chargez
-     la derni&egrave;re version &agrave;
-     <ulink url="&url.mcal;">&url.mcal;</ulink> et compilez la, puis installez la.
+    Pour faire fonctionner cette librairie, vous devez compiler PHP avec
+    l'option <option role="configure">--with-mcal</option>. Il vous faudra
+    alors avoir install&eacute; la librairie mcal. T&eacute;l&eacute;chargez
+    la derni&egrave;re version &agrave;
+    <ulink url="&url.mcal;">&url.mcal;</ulink> et compilez-la,
+    puis installez la.
    </para>
    <para>
-    Les constantes suivantes sont d&eacute;finies lorsque mcal est utilis&eacute;e :
+    Les constantes suivantes sont d&eacute;finies lorsque mcal est
+    utilis&eacute;e :
     MCAL_SUNDAY,
     MCAL_MONDAY,
     MCAL_TUESDAY,
@@ -254,34 +256,73 @@
       par <parameter>id</parameter>.
     </para>
     <para>
-     Retourne un objet &eacute;v&eacute;nement dont les attributs sont :
+     <function>mcal_fetch_event</function> retourne un objet
+     &eacute;v&eacute;nement dont les attributs sont :
      <itemizedlist>
-      <listitem><simpara>
-       int id - ID de l'&eacute;v&eacute;nement.</simpara></listitem>
-      <listitem><simpara>
-       int public - <literal>TRUE</literal> si l'&eacute;v&eacute;nement est public, 
<literal>FALSE</literal> si il est priv&eacute;.</simpara></listitem>
-      <listitem><simpara>
-       string category - Cat&eacute;gorie de 
l'&eacute;v&eacute;nement.</simpara></listitem>
-      <listitem><simpara>
-       string title - Titre de l'&eacute;v&eacute;nement.</simpara></listitem>
-      <listitem><simpara>
-       string description - Description de 
l'&eacute;v&eacute;nement.</simpara></listitem>
-      <listitem><simpara>
-       int alarm - Nombre de minutes avant d'envoyer une alerte pour cet 
&eacute;v&eacute;nement.</simpara></listitem>
-      <listitem><simpara>
-       object start - Objet contenant une date et une heure.</simpara></listitem>
-      <listitem><simpara>
-       object end - Objet contenant une date et une heure.</simpara></listitem>
-      <listitem><simpara>
-       int recur_type   - type de r&eacute;curence</simpara></listitem>
-      <listitem><simpara>
-       int recur_interval   - intervalle de r&eacute;curence</simpara></listitem>
-      <listitem><simpara>
-       datetime recur_endate   - date de fin de r&eacute;curence</simpara></listitem>
-      <listitem><simpara>
-       int recur_data   - donn&eacute;es de r&eacute;curence</simpara></listitem>
+      <listitem>
+       <simpara>
+           int id - ID de l'&eacute;v&eacute;nement.
+          </simpara>
+         </listitem>
+      <listitem>
+       <simpara>
+           int public - <literal>TRUE</literal> si l'&eacute;v&eacute;nement est 
+public,
+           <literal>FALSE</literal> si il est priv&eacute;.
+          </simpara>
+         </listitem>
+      <listitem>
+       <simpara>
+           string category - Cat&eacute;gorie de l'&eacute;v&eacute;nement.
+          </simpara>
+         </listitem>
+      <listitem>
+       <simpara>
+           string title - Titre de l'&eacute;v&eacute;nement.
+          </simpara>
+         </listitem>
+      <listitem>
+       <simpara>
+           string description - Description de l'&eacute;v&eacute;nement.
+          </simpara>
+         </listitem>
+      <listitem>
+       <simpara>
+          int alarm - Nombre de minutes avant d'envoyer une alerte pour cet 
+          &eacute;v&eacute;nement.
+          </simpara>
+         </listitem>
+      <listitem>
+       <simpara>
+           object start - Objet contenant une date et une heure.
+          </simpara>
+         </listitem>
+      <listitem>
+       <simpara>
+           object end - Objet contenant une date et une heure.
+          </simpara>
+         </listitem>
+      <listitem>
+       <simpara>
+           int recur_type   - type de r&eacute;curence
+          </simpara>
+         </listitem>
+      <listitem>
+       <simpara>
+           int recur_interval   - intervalle de r&eacute;curence
+          </simpara>
+         </listitem>
+      <listitem>
+       <simpara>
+           datetime recur_endate   - date de fin de r&eacute;curence
+          </simpara>
+         </listitem>
+      <listitem>
+       <simpara>
+           int recur_data   - donn&eacute;es de r&eacute;curence
+          </simpara>
+         </listitem>
      </itemizedlist>
-      Tous les objets de date et heure sont construits comme suit :
+     Tous les objets de date et heure sont construits comme suit :
      <itemizedlist>
       <listitem><simpara>
        int year - ann&eacute;e</simpara></listitem>
@@ -296,7 +337,47 @@
       <listitem><simpara>
        int sec   - secondes</simpara></listitem>
       <listitem><simpara>
-       int alarm   - nombre de minutes avant de d&eacute;clencher 
l'alarme</simpara></listitem>
+       int alarm   - nombre de minutes avant de d&eacute;clencher l'alarme
+          </simpara>
+         </listitem>
+     </itemizedlist>
+     Les valeurs possibles de recur_type sont :
+     <itemizedlist>
+      <listitem>
+       <simpara>
+           0 - Indique que l'&eacute;v&eacute;nement ne se r&eacute;p&egrave;te jamais
+          </simpara>
+         </listitem>
+      <listitem>
+       <simpara>
+          1 - Indique que l'&eacute;v&eacute;nement se r&eacute;p&egrave;te 
+          tous les jours
+          </simpara>
+         </listitem>
+      <listitem>
+       <simpara>
+           2 - Indique que l'&eacute;v&eacute;nement se r&eacute;p&egrave;te 
+           toutes les semaines
+          </simpara>
+         </listitem>
+      <listitem>
+       <simpara>
+           3 - Indique que l'&eacute;v&eacute;nement se r&eacute;p&egrave;te 
+           tous les mois, &agrave; la m&ecirc;me date (le 10 du mois)
+          </simpara>
+         </listitem>
+      <listitem>
+       <simpara>
+           4 - Indique que l'&eacute;v&eacute;nement se r&eacute;p&egrave;te 
+           tous les mois, un certain jours (i.e., le troisi&egrave;me samedi du mois)
+          </simpara>
+         </listitem>
+      <listitem>
+       <simpara>
+           5 - Indique que l'&eacute;v&eacute;nement se r&eacute;p&egrave;te 
+           tous les ans
+          </simpara>
+         </listitem>
      </itemizedlist>
     </para>
    </refsect1>
@@ -1111,32 +1192,70 @@
      la structure de la date du flot courant sous la forme d'un
      objet, qui contient :
      <itemizedlist>
-      <listitem><simpara>
-       int id - ID de l'&eacute;v&eacute;nement.</simpara></listitem>
-      <listitem><simpara>
-       int public - <literal>TRUE</literal> si l'&eacute;v&eacute;nement est public, 
<literal>FALSE</literal> si il est priv&eacute;.</simpara></listitem>
-      <listitem><simpara>
-       string category - Cat&eacute;gorie de 
l'&eacute;v&eacute;nement.</simpara></listitem>
-      <listitem><simpara>
-       string title - Titre de l'&eacute;v&eacute;nement.</simpara></listitem>
-      <listitem><simpara>
-       string description - Description de 
l'&eacute;v&eacute;nement.</simpara></listitem>
-      <listitem><simpara>
-       int alarm - Nombre de minutes avant d'envoyer une alerte pour cet 
&eacute;v&eacute;nement.</simpara></listitem>
-      <listitem><simpara>
-       object start - Objet contenant une date et une heure.</simpara></listitem>
-      <listitem><simpara>
-       object end - Objet contenant une date et une heure.</simpara></listitem>
-      <listitem><simpara>
-       int recur_type   - type de r&eacute;curence</simpara></listitem>
-      <listitem><simpara>
-       int recur_interval   - intervalle de r&eacute;curence</simpara></listitem>
-      <listitem><simpara>
-       datetime recur_endate   - date de fin de r&eacute;curence</simpara></listitem>
-      <listitem><simpara>
-       int recur_data   - donn&eacute;es de r&eacute;curence</simpara></listitem>
+      <listitem>
+       <simpara>
+           int id - ID de l'&eacute;v&eacute;nement.
+          </simpara>
+         </listitem>
+      <listitem>
+       <simpara>
+           int public - <literal>TRUE</literal> si l'&eacute;v&eacute;nement est 
+public,
+           <literal>FALSE</literal> si il est priv&eacute;.
+          </simpara>
+         </listitem>
+      <listitem>
+       <simpara>
+           string category - Cat&eacute;gorie de l'&eacute;v&eacute;nement.
+          </simpara>
+         </listitem>
+      <listitem>
+       <simpara>
+           string title - Titre de l'&eacute;v&eacute;nement.
+          </simpara>
+         </listitem>
+      <listitem>
+       <simpara>
+           string description - Description de l'&eacute;v&eacute;nement.
+          </simpara>
+         </listitem>
+      <listitem>
+       <simpara>
+          int alarm - Nombre de minutes avant d'envoyer une alerte pour cet 
+          &eacute;v&eacute;nement.
+          </simpara>
+         </listitem>
+      <listitem>
+       <simpara>
+           object start - Objet contenant une date et une heure.
+          </simpara>
+         </listitem>
+      <listitem>
+       <simpara>
+           object end - Objet contenant une date et une heure.
+          </simpara>
+         </listitem>
+      <listitem>
+       <simpara>
+           int recur_type   - type de r&eacute;curence
+          </simpara>
+         </listitem>
+      <listitem>
+       <simpara>
+           int recur_interval   - intervalle de r&eacute;curence
+          </simpara>
+         </listitem>
+      <listitem>
+       <simpara>
+           datetime recur_endate   - date de fin de r&eacute;curence
+          </simpara>
+         </listitem>
+      <listitem>
+       <simpara>
+           int recur_data   - donn&eacute;es de r&eacute;curence
+          </simpara>
+         </listitem>
      </itemizedlist>
-      Tous les objets de date et heure sont construits comme suit :
+     Tous les objets de date et heure sont construits comme suit :
      <itemizedlist>
       <listitem><simpara>
        int year - ann&eacute;e</simpara></listitem>
@@ -1152,6 +1271,44 @@
        int sec   - secondes</simpara></listitem>
       <listitem><simpara>
        int alarm   - nombre de minutes avant de d&eacute;clencher 
l'alarme</simpara></listitem>
+     </itemizedlist>
+     Les valeurs possibles de recur_type sont :
+     <itemizedlist>
+      <listitem>
+       <simpara>
+           0 - Indique que l'&eacute;v&eacute;nement ne se r&eacute;p&egrave;te jamais
+          </simpara>
+         </listitem>
+      <listitem>
+       <simpara>
+          1 - Indique que l'&eacute;v&eacute;nement se r&eacute;p&egrave;te 
+          tous les jours
+          </simpara>
+         </listitem>
+      <listitem>
+       <simpara>
+           2 - Indique que l'&eacute;v&eacute;nement se r&eacute;p&egrave;te 
+           toutes les semaines
+          </simpara>
+         </listitem>
+      <listitem>
+       <simpara>
+           3 - Indique que l'&eacute;v&eacute;nement se r&eacute;p&egrave;te 
+           tous les mois, &agrave; la m&ecirc;me date (le 10 du mois)
+          </simpara>
+         </listitem>
+      <listitem>
+       <simpara>
+           4 - Indique que l'&eacute;v&eacute;nement se r&eacute;p&egrave;te 
+           tous les mois, un certain jours (i.e., le troisi&egrave;me samedi du mois)
+          </simpara>
+         </listitem>
+      <listitem>
+       <simpara>
+           5 - Indique que l'&eacute;v&eacute;nement se r&eacute;p&egrave;te 
+           tous les ans
+          </simpara>
+         </listitem>
      </itemizedlist>
     </para>
    </refsect1>