[PHP-DOC] cvs: phpdoc /fr/functions array.xml ccvs.xml datetime.xml imap.xml mcal.xml pcre.xml pdf.xml

[Damien Seguy]

dams            Fri Mar  2 07:28:05 2001 EDT

  Modified files:              
    /phpdoc/fr/functions        ccvs.xml datetime.xml imap.xml mcal.xml 
                                pcre.xml pdf.xml array.xml 
  Log:
  Added lastest updates (two imap new functions)
  
Index: phpdoc/fr/functions/ccvs.xml
diff -u phpdoc/fr/functions/ccvs.xml:1.3 phpdoc/fr/functions/ccvs.xml:1.4
--- phpdoc/fr/functions/ccvs.xml:1.3    Tue Jan 16 02:38:38 2001
+++ phpdoc/fr/functions/ccvs.xml        Fri Mar  2 07:28:05 2001
@@ -44,26 +44,12 @@
     url="&url.redhat.ccvs;">&url.redhat.ccvs;</ulink>.
    </simpara>
    <simpara>
-    Cette documentatin est en chantier. Jusqu'&agrave; sa finalisation, RedHat
-    entretient une version l&eacute;g&egrave;rement d&eacute;mod&eacute;e mais bien 
pratique
-    &agrave; <ulink url="&url.redhat.support;">&url.redhat.support;</ulink>.
+    Cette documentation est en chantier. Jusqu'&agrave; sa finalisation, RedHat
+    entretient une version l&eacute;g&egrave;rement d&eacute;mod&eacute;e 
+    mais bien pratique &agrave; 
+    <ulink url="&url.redhat.support;">&url.redhat.support;</ulink>.
    </simpara>
   </partintro>
-  <refentry>
-   <refnamediv>
-    <refname></refname>
-    <refpurpose></refpurpose>
-   </refnamediv>
-   <refsect1>
-    <title></title>
-    <funcsynopsis>
-     <funcprototype>
-      <funcdef> <function></function></funcdef>
-      <paramdef> <parameter></parameter></paramdef>
-     </funcprototype>
-    </funcsynopsis>
-   </refsect1>
-  </refentry>
  </reference>
 <!-- Keep this comment at the end of the file
 Local variables:
Index: phpdoc/fr/functions/datetime.xml
diff -u phpdoc/fr/functions/datetime.xml:1.11 phpdoc/fr/functions/datetime.xml:1.12
--- phpdoc/fr/functions/datetime.xml:1.11       Sun Feb  4 10:22:44 2001
+++ phpdoc/fr/functions/datetime.xml    Fri Mar  2 07:28:05 2001
@@ -17,7 +17,11 @@
      </funcprototype>
     </funcsynopsis>
     <para>
-     <function>checkdate</function> retourne <literal>TRUE</literal> si la date 
fournie est valide, et sinon <literal>FALSE</literal>.
+     <function>checkdate</function> retourne <literal>TRUE</literal> 
+     si la date 
+     
+<parameter>day</parameter>/<parameter>month</parameter>/<parameter>year</parameter>
+     est valide, et sinon <literal>FALSE</literal>. 
+     Notez bien que l'ordre des arguments n'est pas l'ordre fran&ccedil;ais.
      La date est consid&eacute;r&eacute;e comme valide si :
      <itemizedlist>
       <listitem>
@@ -923,7 +927,7 @@
     <para>
      Voir aussi <function>setlocale</function> et <function>mktime</function>
      et le <ulink url="&spec.strftime;">groupe de sp&eacute;cifications de
-     <function>strftime</function></ulink>.
+     strftime()</ulink>.
     </para>
    </refsect1>
   </refentry>
Index: phpdoc/fr/functions/imap.xml
diff -u phpdoc/fr/functions/imap.xml:1.8 phpdoc/fr/functions/imap.xml:1.9
--- phpdoc/fr/functions/imap.xml:1.8    Wed Feb  7 01:11:59 2001
+++ phpdoc/fr/functions/imap.xml        Fri Mar  2 07:28:05 2001
@@ -1005,6 +1005,68 @@
        </para>
    </refsect1>
   </refentry>
+  <refentry id="function.imap-get-quota">
+   <refnamediv>
+    <refname>imap_get_quota</refname>
+    <refpurpose>
+     Lit les quotas des bo�tes aux lettres
+    </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <funcsynopsis>
+     <funcprototype>
+      <funcdef>array <function>imap_get_quota</function></funcdef>
+      <paramdef>int <parameter>imap_stream</parameter></paramdef>
+      <paramdef>string <parameter>quota_root</parameter></paramdef>
+     </funcprototype>
+    </funcsynopsis>
+    <para>
+     <function>imap_get_quota</function> retourne un tableau contenant
+     les valeurs de quota et courante de la bo�te aux lettres
+     <parameter>quota_root</parameter>. Le quota repr�sente la 
+     taille maximale de votre bo�te aux lettres. La valeur courante
+     est l'espace actuellement utilis� par votre bo�te aux lettres.
+     <function>imap_get_quota</function> retournera <literal>FALSE</literal>
+     en cas d'�chec.
+    </para>
+    <para>
+     <function>imap_get_quota</function> ne fonctionne actuellement qu'avec 
+     les librairies c-client2000.
+    </para>
+    <para>
+     <parameter>imap_stream</parameter> doit avoir �t� cr��
+     avec la fonction <function>imap_status</function>. Ce flot est
+     n�cessairement ouvert en tant qu'administrateur du serveur, pour que
+     les droits n�cessaires lui soit allou�. 
+     <parameter>quota_root</parameter> doit �tre de la forme :
+     "<literal>user.nom</literal>", o� "nom" est le nom de la
+     bo�te aux lettres que vous souhaitez analyser.
+    </para>
+    <para>
+     <example>
+      <title>Exemple avec <function>imap_get_quota</function></title>
+      <programlisting role="php">
+&lt;?php
+$mbox = imap_open("{votre.hote.imap}","mailadmin","mot de passe",OP_HALFOPEN)
+      || die("Connexion impossible : ".imap_last_error());
+ 
+$quota_value = imap_get_quota($mbox, "user.toto");
+if(is_array($quota_value)) {
+    print "Utilisation actuelle : " . $quota_value['usage'];
+    print "Quota : " . $quota_value['limit'];
+} 
+imap_close($mbox); 
+?&gt;
+      </programlisting>
+     </example>
+    </para>
+    <para>
+     Voir aussi <function>imap_open</function> et
+     <function>imap_set_quota</function>.
+    </para>
+   </refsect1>
+  </refentry>
   <refentry id="function.imap-listsubscribed">
    <refnamediv>
     <refname>imap_listsubscribed</refname>
@@ -1026,6 +1088,72 @@
      Les arguments <parameter>ref</parameter> et <parameter>pattern</parameter>
      indiquent respectivement, le dossier o&uacute; chercher et le nom des
      bo&icirc;tes recherch&eacute;es, sous la forme d'un masque.
+    </para>
+   </refsect1>
+  </refentry>
+  <refentry id="function.imap-set-quota">
+   <refnamediv>
+    <refname>imap_set_quota</refname>
+    <refpurpose>Modifie le quota d'une bo�te aux lettres</refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <funcsynopsis>
+     <funcprototype>
+      <funcdef>int <function>imap_set_quota</function></funcdef>
+      <paramdef>int <parameter>imap_stream</parameter></paramdef>
+      <paramdef>string <parameter>quota_root</parameter></paramdef>
+      <paramdef>int <parameter>quota_limit</parameter></paramdef>
+     </funcprototype>
+    </funcsynopsis>
+    <para>  
+     <function>imap_set_quota</function> modifie le quota de la 
+     bo�te aux lettres <parameter>quota_root</parameter>, en la 
+     fixant � <parameter>quota_limit</parameter>. <function>imap_set_quota</function>
+     requiert que <parameter>imap_stream</parameter> ait �t�
+     ouvert avec un compte d'administrateur, pour avoir les droits 
+     n�cessaires : elle ne fonctionnera avec aucun autre
+     utilisateur.
+    </para>
+    <para>
+     <function>imap_get_quota</function> ne fonctionne actuellement qu'avec 
+     les librairies c-client2000.
+    </para>
+    <para>
+     <parameter>imap_stream</parameter> doit avoir �t� cr��
+     avec la fonction <function>imap_status</function>. Ce flot est
+     n�cessairement ouvert en tant qu'administrateur du serveur, pour que
+     les droits n�cessaires lui soit allou�. 
+     <parameter>quota_root</parameter> doit �tre de la forme :
+     "<literal>user.nom</literal>", o� "nom" est le nom de la
+     bo�te aux lettres que vous souhaitez analyser.
+    <parameter>quota_limit</parameter> est la nouvelle taille 
+    maximum (en ko) de la bo�te <parameter>quota_root</parameter>. 
+    </para>
+    <para>
+     <function>imap_set_quota</function> retourne <literal>TRUE</literal>
+     en cas de succ�s, et <literal>FALSE</literal> sinon.
+    </para>
+    <para>
+     <example>
+      <title><function>imap_set_quota</function> example</title>
+      <programlisting role="php">
+&lt;?php
+$mbox = imap_open ("{votre.hote.imap:143}", "mailadmin", "mot de passe");
+
+if(!imap_set_quota($mbox, "user.toto", 3000)) {
+       print "Erreur lors de la modification des quotas\n";
+       return;
+}
+
+imap_close($mbox);
+?&gt;
+      </programlisting>
+     </example>
+    </para>
+    <para>
+     Voir aussi <function>imap_open</function> et
+     <function>imap_set_quota</function>.
     </para>
    </refsect1>
   </refentry>
Index: phpdoc/fr/functions/mcal.xml
diff -u phpdoc/fr/functions/mcal.xml:1.8 phpdoc/fr/functions/mcal.xml:1.9
--- phpdoc/fr/functions/mcal.xml:1.8    Thu Feb 22 03:04:28 2001
+++ phpdoc/fr/functions/mcal.xml        Fri Mar  2 07:28:05 2001
@@ -429,12 +429,13 @@
      </funcprototype>
     </funcsynopsis>
     <para>
-      <function>mcal_append_event</function> enregistre
-      l'&eacute;v&eacute;nement global dans le calendrier
-      MCAL <parameter>mcal_stream</parameter>.
+     <function>mcal_append_event</function> enregistre
+     l'&eacute;v&eacute;nement global dans le calendrier
+     MCAL <parameter>mcal_stream</parameter>.
     </para>
     <para>
-     Retourne l'uid de l'enregistement ainsi ins&eacute;r&eacute;.
+     <function>mcal_append_event</function> retourne l'uid de l'enregistement
+     ainsi ins&eacute;r&eacute;.
     </para>
    </refsect1>
   </refentry>
@@ -442,7 +443,7 @@
    <refnamediv>
     <refname>mcal_store_event</refname>
     <refpurpose>
-      Modifie un &eacute;v&eacute;nement dans un calendrier MCAL.
+     Modifie un &eacute;v&eacute;nement dans un calendrier MCAL.
     </refpurpose>
    </refnamediv>
    <refsect1>
@@ -459,7 +460,9 @@
      MCAL <parameter>mcal_stream</parameter>.
     </para>
     <para>
-      Retourne <literal>TRUE</literal> en cas de succ&egrave;s, et 
<literal>FALSE</literal> en cas d'erreur.
+     <function>mcal_store_event</function> retourne l'identifiant
+     de l'�v�nement modifi� en cas de succ&egrave;s, et
+     <literal>FALSE</literal> en cas d'erreur.
     </para>
    </refsect1>
   </refentry>
@@ -502,12 +505,12 @@
      </funcprototype>
     </funcsynopsis>
     <para>
-      <function>mcal_snooze</function> &eacute;teind l'alarme de
-      l'&eacute;v&eacute;nement identifi&eacute; par l'UID
-      <parameter>uid</parameter>.
+     <function>mcal_snooze</function> &eacute;teind l'alarme de
+     l'&eacute;v&eacute;nement identifi&eacute; par l'UID
+     <parameter>uid</parameter>.
     </para>
     <para>
-     Retourne <literal>TRUE</literal>.
+     <function>mcal_snooze</function> retourne <literal>TRUE</literal>.
     </para>
    </refsect1>
   </refentry>
@@ -573,12 +576,12 @@
      </funcprototype>
     </funcsynopsis>
     <para>
-      <function>mcal_event_init</function> initialise la structure
-      globale d'un flot. Cela remet tous les &eacute;l&eacute;ments
-      de la structure &agrave; 0, ou &agrave; leur valeur par d&eacute;faut.
+     <function>mcal_event_init</function> initialise la structure
+     globale d'un flot. Cela remet tous les &eacute;l&eacute;ments
+     de la structure &agrave; 0, ou &agrave; leur valeur par d&eacute;faut.
     </para>
     <para>
-     Retourne <literal>TRUE</literal>.
+     <function>mcal_event_init</function> retourne <literal>TRUE</literal>.
     </para>
    </refsect1>
   </refentry>
@@ -604,7 +607,8 @@
      valeur de <parameter>category</parameter>.
     </para>
     <para>
-     Retourne <literal>TRUE</literal>.
+     <function>mcal_event_set_category</function> retourne 
+     <literal>TRUE</literal>.
     </para>
    </refsect1>
   </refentry>
@@ -629,7 +633,7 @@
      la structure globale &agrave; la valeur de <parameter>title</parameter>.
     </para>
     <para>
-     Retourne <literal>TRUE</literal>.
+     <function>mcal_event_set_title</function> retourne <literal>TRUE</literal>.
     </para>
    </refsect1>
   </refentry>
@@ -702,7 +706,7 @@
      d&eacute;but de la structure globale.
     </para>
     <para>
-     Retourne <literal>TRUE</literal>.
+     <function>mcal_event_set_start</function> retourne <literal>TRUE</literal>.
     </para>
    </refsect1>
   </refentry>
@@ -774,7 +778,7 @@
      d&eacute;clenchement.
     </para>
     <para>
-     Retourne <literal>TRUE</literal>.
+     <function>mcal_event_set_alarm</function> retourne <literal>TRUE</literal>.
     </para>
    </refsect1>
   </refentry>
@@ -800,7 +804,7 @@
      pour priv&eacute;e.
     </para>
     <para>
-     Retourne <literal>TRUE</literal>.
+     <function>mcal_event_set_class</function> retourne <literal>TRUE</literal>.
     </para>
    </refsect1>
   </refentry>
@@ -969,8 +973,8 @@
     </funcsynopsis>
     <para>
      <function>mcal_date_compare</function> compares les deux
-     dates donn&eacute;es, et retourne &lt;0, 0, >0 si a&lt;b,
-      a==b, a>b respectivement.
+     dates donn&eacute;es, et retourne &lt;0, 0, &gt; 0 si a&lt;b,
+      a==b, a&gt;b respectivement.
     </para>
    </refsect1>
   </refentry>
@@ -978,7 +982,7 @@
    <refnamediv>
     <refname>mcal_next_recurrence</refname>
     <refpurpose>
-      Retourne la prochaine occurence d'une &eacute;v&eacute;nement.
+     Retourne la prochaine occurence d'une &eacute;v&eacute;nement.
     </refpurpose>
    </refnamediv>
    <refsect1>
@@ -994,7 +998,8 @@
     <para>
      <function>mcal_next_recurrence</function> retourne un objet
      contenant la prochaine date de l'&eacute;v&eacute;nement, ou
-     la date de l'&eacute;v&eacute;nement suivant la date. Retourne
+     la date de l'&eacute;v&eacute;nement suivant la date. 
+     <function>mcal_next_recurrence</function> retourne
      un objet date vide si l'&eacute;v&eacute;nement n'a pas de
      r&eacute;occurence, ou si quelquechose est invalide. Utilisez
      <parameter>weekstart</parameter> pour d&eacute;terminer le premier jour.
Index: phpdoc/fr/functions/pcre.xml
diff -u phpdoc/fr/functions/pcre.xml:1.18 phpdoc/fr/functions/pcre.xml:1.19
--- phpdoc/fr/functions/pcre.xml:1.18   Wed Feb 21 02:39:50 2001
+++ phpdoc/fr/functions/pcre.xml        Fri Mar  2 07:28:05 2001
@@ -281,7 +281,10 @@
 &lt;?php
 // Cet exemple utilise les r&eacute;f&eacute;rences arri&egrave;res (\\2).
 // Elles indiquent &agrave; l'analyseur qu'il doit trouver quelquechose qu'il
-// a d&eacute;j&agrave; rep&eacute;r&eacute; un peu plus t&ocirc;t (ici, ([\w]+)).
+// a d&eacute;j&agrave; rep&eacute;r&eacute; un peu plus t&ocirc;t 
+// le nombre 2 indique que c'est le deuxi�me jeu de parenth�ses
+// capturante qui doit �tre utilis� (ici, ([\w]+)).
+//  L'antislash est n�cessaire ici, car la cha�ne est entre guillemets doubles
 $html = "&lt;B&gt;Texte en gras&lt;/B&gt;&lt;a href=salut.html&gt;clique moi&lt;/?&gt;
 preg_match_all ("/(&lt;([\w]+)[?&gt;]?&gt;)(.*)(&lt;\/\\?&gt;)/", $html, $matches);
 for ($i=0; $i&lt; count($matches[0]); $i++) {
Index: phpdoc/fr/functions/pdf.xml
diff -u phpdoc/fr/functions/pdf.xml:1.11 phpdoc/fr/functions/pdf.xml:1.12
--- phpdoc/fr/functions/pdf.xml:1.11    Mon Feb 26 03:10:50 2001
+++ phpdoc/fr/functions/pdf.xml Fri Mar  2 07:28:05 2001
@@ -257,7 +257,7 @@
      signifique notamment qu'il faut remplacer 4 par 'winansi'.
     </simpara>
     <simpara>
-     Si vous utilisez PDFLib 2.30, <function>pdf_set_text_matrix</function>
+     Si vous utilisez PDFLib 2.30, pdf_set_text_matrix()
      a disparu. Elle n'est plus support&eacute;. En g&eacute;n&eacute;ral,
      il est recommand&eacute; de consulter les notes de version de la PDFLib
      pour lister toutes les modifications.
@@ -1543,14 +1543,11 @@
      </funcprototype>
     </funcsynopsis>
     <para>
-      <function>pdf_place_image</function> place l'image <parameter>image</parameter>
-      dans la page courante, &agrave; la position (<parameter>x-coor</parameter>,
-      <parameter>x-coor</parameter>). L'image peut changer d'&eacute;chelle
-      simultan&eacute;mement.
+     <function>pdf_place_image</function> place l'image <parameter>image</parameter>
+     dans la page courante, &agrave; la position (<parameter>x-coor</parameter>,
+     <parameter>x-coor</parameter>). L'image peut changer d'&eacute;chelle
+     simultan&eacute;mement.
     </para>
-    <para>
-      Voir aussi <function>pdf_put_image</function>.
-    </para>
    </refsect1>
   </refentry>
   <refentry id="function.pdf-rect">
@@ -2358,7 +2355,7 @@
     </para>
    </refsect1>
   </refentry>
-  <refentry id="function.pdf-set-transition">
+  <refentry id="function.pdf-set-text-matrix">
    <refnamediv>
     <refname>pdf_set_text_matrix</refname>
     <refpurpose>Obsol&egrave;te: Modifie la transition des pages</refpurpose>
@@ -2366,7 +2363,7 @@
    <refsect1>
     <title>Description</title>
     <para>
-     See <function>pdf_set_parameter</function>.
+     Voir <function>pdf_set_parameter</function>.
     </para>
    </refsect1>
   </refentry>
@@ -2671,7 +2668,6 @@
      Voir aussi <function>pdf_close_image</function>,
      <function>pdf_open_jpeg</function>,
      <function>pdf_open_gif</function>,
-     <function>pdf_execute_image</function>,
      <function>pdf_place_image</function> et
      <function>pdf_put_image</function>.
    </para>
Index: phpdoc/fr/functions/array.xml
diff -u phpdoc/fr/functions/array.xml:1.22 phpdoc/fr/functions/array.xml:1.23
--- phpdoc/fr/functions/array.xml:1.22  Tue Feb 20 06:40:31 2001
+++ phpdoc/fr/functions/array.xml       Fri Mar  2 07:28:05 2001
@@ -1797,13 +1797,13 @@
      </computeroutput>
     </para>
     <para>
-      La variable $taille n'a pas &eacute;t&eacute; r&eacute;&eacute;crite, car on
-      avait sp&eacute;cifi&eacute; le param&egrave;tre EXTR_PREFIX_SAME, qui a permis
-      la cr&eacute;ation $wddx_size. Si EXTR_SKIP avait &eacute;t&eacute;
-      utilis&eacute;, alors $wddx_size n'aurait pas &eacute;t&eacute;
-      cr&eacute;&eacute;. Avec EXTR_OVERWRITE, $taille aurait pris la valeur "moyen",
-      et avec EXTR_PREFIX_ALL, les variables cr&eacute;&eacute;es seraient
-      $wddx_couleur, $wddx_taille, et $wddx_forme.
+     La variable $taille n'a pas &eacute;t&eacute; r&eacute;&eacute;crite, car on
+     avait sp&eacute;cifi&eacute; le param&egrave;tre EXTR_PREFIX_SAME, qui a permis
+     la cr&eacute;ation $wddx_size. Si EXTR_SKIP avait &eacute;t&eacute;
+     utilis&eacute;, alors $wddx_size n'aurait pas &eacute;t&eacute;
+     cr&eacute;&eacute;. Avec EXTR_OVERWRITE, $taille aurait pris la valeur "moyen",
+     et avec EXTR_PREFIX_ALL, les variables cr&eacute;&eacute;es seraient
+     $wddx_couleur, $wddx_taille, et $wddx_forme.
     </para>
    </refsect1>
   </refentry>
@@ -1826,7 +1826,8 @@
     </funcsynopsis>
     <para>
      <function>in_array</function> recherche <parameter>needle</parameter> dans
-     <parameter>haystack</parameter> et retourne <literal>TRUE</literal> si il s'y 
trouve, ou <literal>FALSE</literal> sinon.
+     <parameter>haystack</parameter> et retourne <literal>TRUE</literal> 
+     si il s'y trouve, ou <literal>FALSE</literal> sinon.
     </para>
     <para>
      Si le troisi&egrave;me param&egrave;tre <parameter>strict</parameter> est 
optionel. S'il
@@ -1848,7 +1849,9 @@
     </para>
     <para>
      <example>
-      <title><function>in_array</function> avec le param&egrave;tre 
<parameter>strict</parameter></title>
+      <title>
+       <function>in_array</function> avec le param&egrave;tre 
+<parameter>strict</parameter>
+      </title>
       <programlisting role="php">
 &lt;?php
 $a = array('1.10', 12.4, 1.13);
@@ -1878,10 +1881,12 @@
     </para>
    </refsect1>
   </refentry>
-  <refentry id="function.search-array">
+  <refentry id="function.array-search">
    <refnamediv>
     <refname>array_search</refname>
-    <refpurpose>Recherche dans un tableau la cl&eacute; associ&eacute;e &agrave; une 
valeur</refpurpose>
+    <refpurpose>
+     Recherche dans un tableau la cl&eacute; associ&eacute;e &agrave; une valeur
+    </refpurpose>
    </refnamediv>
    <refsect1>
     <title>Description</title>