event section sync with EN (#793)

php · Feb 10, 2024 · ec97be1 · ec97be1
1 parent fa7253a
commit ec97be1
Show file tree

Hide file tree

Showing 14 changed files with 157 additions and 102 deletions.
diff --git a/reference/event/book.xml b/reference/event/book.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 68c2c871505aadf983f16113c5b077b335ce8d76 Maintainer: yannick Status: ready -->
+<!-- EN-Revision: b621ab27a9d333285df99a03825b36a87eb67cad Maintainer: yannick Status: ready -->
 <!-- Reviewed: no -->
 
 <book xml:id="book.event" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
@@ -53,6 +53,7 @@
  &reference.event.eventlistener;
  &reference.event.eventsslcontext;
  &reference.event.eventutil;
+ &reference.event.eventexception;
 
 </book>
 <!-- Keep this comment at the end of the file

diff --git a/reference/event/event/construct.xml b/reference/event/event/construct.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 919c8a799262f08bb0da4b70ab52f07ec670fc17 Maintainer: yannick Status: ready -->
+<!-- EN-Revision: b621ab27a9d333285df99a03825b36a87eb67cad Maintainer: yannick Status: ready -->
 <!-- Reviewed: no -->
 
 <refentry xml:id="event.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
@@ -103,12 +103,6 @@
    </varlistentry>
   </variablelist>
  </refsect1>
- <refsect1 role="returnvalues">
-  &reftitle.returnvalues;
-  <para>
-   Retourne l'objet Event.
-  </para>
- </refsect1>
  <refsect1 role="seealso">
   &reftitle.seealso;
   <simplelist>

diff --git a/reference/event/eventbase/construct.xml b/reference/event/eventbase/construct.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 919c8a799262f08bb0da4b70ab52f07ec670fc17 Maintainer: yannick Status: ready -->
+<!-- EN-Revision: b621ab27a9d333285df99a03825b36a87eb67cad Maintainer: yannick Status: ready -->
 <!-- Reviewed: no -->
 
 <refentry xml:id="eventbase.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
@@ -37,10 +37,11 @@
    </varlistentry>
   </variablelist>
  </refsect1>
- <refsect1 role="returnvalues">
-  &reftitle.returnvalues;
+ <refsect1 role="errors">
+  &reftitle.errors;
   <para>
-   Retourne un objet EventBase.
+   Si <classname>EventBase</classname> ne peut pas être construit avec la configuration fournie,
+   une exception de type <classname>EventException</classname> sera déclenchée.
   </para>
  </refsect1>
  <refsect1 role="seealso">

diff --git a/reference/event/eventbuffer/construct.xml b/reference/event/eventbuffer/construct.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 919c8a799262f08bb0da4b70ab52f07ec670fc17 Maintainer: yannick Status: ready -->
+<!-- EN-Revision: b621ab27a9d333285df99a03825b36a87eb67cad Maintainer: yannick Status: ready -->
 <!-- Reviewed: no -->
 
 <refentry xml:id="eventbuffer.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
@@ -23,12 +23,6 @@
   &reftitle.parameters;
   &no.function.parameters;
  </refsect1>
- <refsect1 role="returnvalues">
-  &reftitle.returnvalues;
-  <para>
-   Retourne un objet EventBuffer.
-  </para>
- </refsect1>
 </refentry>
 <!-- Keep this comment at the end of the file
 Local variables:

diff --git a/reference/event/eventbufferevent/construct.xml b/reference/event/eventbufferevent/construct.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 235a4b9e5a263de6b122c80e6e8142508a36951d Maintainer: yannick Status: ready -->
+<!-- EN-Revision: b621ab27a9d333285df99a03825b36a87eb67cad Maintainer: yannick Status: ready -->
 <!-- Reviewed: no -->
 <refentry xml:id="eventbufferevent.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
@@ -141,13 +141,6 @@
    </varlistentry>
   </variablelist>
  </refsect1>
- <refsect1 role="returnvalues">
-  &reftitle.returnvalues;
-  <para>
-   Retourne une ressource de tampon d'événement, associée à la ressource
-   de socket.
-  </para>
- </refsect1>
  <refsect1 role="seealso">
   &reftitle.seealso;
   <simplelist>

diff --git a/reference/event/eventconfig/construct.xml b/reference/event/eventconfig/construct.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: e26545dcabdf763f6b3b9f792524b6cf16d99457 Maintainer: yannick Status: ready -->
+<!-- EN-Revision: b621ab27a9d333285df99a03825b36a87eb67cad Maintainer: yannick Status: ready -->
 <!-- Reviewed: no -->
 
 <refentry xml:id="eventconfig.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
@@ -25,14 +25,6 @@
   &reftitle.parameters;
   &no.function.parameters;
  </refsect1>
-
- <refsect1 role="returnvalues">
-  &reftitle.returnvalues;
-  <para>
-   Retourne un objet <classname>EventConfig</classname>.
-  </para>
- </refsect1>
-
  <refsect1 role="examples">
   &reftitle.examples;
   <example>

diff --git a/reference/event/eventdnsbase.xml b/reference/event/eventdnsbase.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 86e6094e86b84a51d00ab217ac50ce8dde33d82a Maintainer: yannick Status: ready -->
+<!-- EN-Revision: b621ab27a9d333285df99a03825b36a87eb67cad Maintainer: yannick Status: ready -->
 <!-- Reviewed: no -->
 
 <phpdoc:classref xml:id="class.eventdnsbase" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
@@ -33,7 +33,7 @@
      </ooclass>
     </classsynopsisinfo>
 <!-- }}} -->
-    <classsynopsisinfo role="comment">Constants</classsynopsisinfo>
+    <classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
     <fieldsynopsis>
      <modifier>const</modifier>
      <type>int</type>
@@ -64,10 +64,31 @@
      <varname linkend="eventdnsbase.constants.options-all">EventDnsBase::OPTIONS_ALL</varname>
      <initializer>15</initializer>
     </fieldsynopsis>
+    <fieldsynopsis>
+     <modifier>const</modifier>
+     <type>int</type>
+     <varname linkend="eventdnsbase.constants.disable-when-inactive">EventDnsBase::DISABLE_WHEN_INACTIVE</varname>
+     <initializer>32768</initializer>
+    </fieldsynopsis>
+    <fieldsynopsis>
+     <modifier>const</modifier>
+     <type>int</type>
+     <varname linkend="eventdnsbase.constants.initialize-nameservers">EventDnsBase::INITIALIZE_NAMESERVERS</varname>
+     <initializer>1</initializer>
+    </fieldsynopsis>
+    <fieldsynopsis>
+     <modifier>const</modifier>
+     <type>int</type>
+     <varname linkend="eventdnsbase.constants.nameservers-no-default">EventDnsBase::NAMESERVERS_NO_DEFAULT</varname>
+     <initializer>65536</initializer>
+    </fieldsynopsis>
     <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
-    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.eventdnsbase')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook)
+xpointer(id('class.eventdnsbase')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[1])" />
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook)
+xpointer(id('class.eventdnsbase')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
    </classsynopsis>
-<!-- }}} -->
+   <!-- }}} -->
   </section>
 <!-- {{{ EventDnsBase constants -->
   <section xml:id="eventdnsbase.constants">
@@ -129,6 +150,36 @@
       </para>
      </listitem>
     </varlistentry>
+    <varlistentry xml:id="eventdnsbase.constants.disable-when-inactive">
+     <term>
+      <constant>EventDnsBase::DISABLE_WHEN_INACTIVE</constant>
+     </term>
+     <listitem>
+      <para>
+       Ne pas empêcher la boucle d'événements de libevent de se terminer lorsque nous n'avons pas de requêtes DNS actives.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry xml:id="eventdnsbase.constants.initialize-nameservers">
+     <term>
+      <constant>EventDnsBase::INITIALIZE_NAMESERVERS</constant>
+     </term>
+     <listitem>
+      <para>
+       Traiter le fichier <literal>resolv.conf</literal>.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry xml:id="eventdnsbase.constants.nameservers-no-default">
+     <term>
+      <constant>EventDnsBase::NAMESERVERS_NO_DEFAULT</constant>
+     </term>
+     <listitem>
+      <para>
+       Ne pas ajouter de serveur de noms par défaut s'il n'y a pas de serveurs de noms dans le fichier <literal>resolv.conf</literal>.
+      </para>
+     </listitem>
+    </varlistentry>
    </variablelist>
   </section>
 <!-- }}} -->

diff --git a/reference/event/eventdnsbase/construct.xml b/reference/event/eventdnsbase/construct.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 919c8a799262f08bb0da4b70ab52f07ec670fc17 Maintainer: yannick Status: ready -->
+<!-- EN-Revision: b621ab27a9d333285df99a03825b36a87eb67cad Maintainer: yannick Status: ready -->
 <!-- Reviewed: no -->
 
 <refentry xml:id="eventdnsbase.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
@@ -10,18 +10,18 @@
  </refnamediv>
  <refsect1 role="description">
   &reftitle.description;
-  <methodsynopsis>
+  <constructorsynopsis role="EventDnsBase">
    <modifier>public</modifier>
    <methodname>EventDnsBase::__construct</methodname>
    <methodparam>
     <type>EventBase</type>
     <parameter>base</parameter>
    </methodparam>
    <methodparam>
-    <type>bool</type>
+    <type class="union"><type>int</type><type>bool</type></type>
     <parameter>initialize</parameter>
    </methodparam>
-  </methodsynopsis>
+  </constructorsynopsis>
   <para>
    Construit un objet EventDnsBase.
   </para>
@@ -45,21 +45,93 @@
     </term>
     <listitem>
      <para>
-      Si l'argument <parameter>initialize</parameter> vaut &true;,
-      il tentera de configurer la sensibilité de base du DNS fournie
-      par le système opérant. Sinon, il laissera l'événement de base DNS
-      vide, avec aucun serveur de noms ou options de configuré.
-      Plus tard, la base du DNS devra être configurée manuellement, i.e.
-      avec la méthode <methodname>EventDnsBase::parseResolvConf</methodname>.
+      Si <parameter>initialize</parameter> est &true;, il tente d'utiliser les paramètres par défaut du système d'exploitation sous-jacent pour configurer judicieusement la base DNS.
+      Si c'est &false;, la base DNS est laissée non configurée, sans serveurs de noms ni options définies.
+      Dans ce dernier cas, la base DNS doit être configurée manuellement, par exemple avec la méthode <methodname>EventDnsBase::parseResolvConf</methodname>.
+     </para>
+     <para>
+      Si <parameter>initialize</parameter> est un entier, il doit être l'un des drapeaux suivants:
+      <informaltable>
+       <tgroup cols="2">
+        <thead>
+         <row>
+          <entry valign="top">Drapeau</entry>
+          <entry valign="top">&Description;</entry>
+         </row>
+        </thead>
+        <tbody>
+         <row>
+          <entry valign="top"><constant>EventDnsBase::DISABLE_WHEN_INACTIVE</constant></entry>
+          <entry valign="top">
+           Ne pas empêcher la boucle d'événements de libevent de se terminer lorsque nous n'avons pas de requêtes DNS actives.
+          </entry>
+         </row>
+         <row>
+          <entry valign="top"><constant>EventDnsBase::INITIALIZE_NAMESERVERS</constant></entry>
+          <entry valign="top">
+           Traiter le fichier <literal>resolv.conf</literal>.
+          </entry>
+         </row>
+         <row>
+          <entry valign="top"><constant>EventDnsBase::NAMESERVERS_NO_DEFAULT</constant></entry>
+          <entry valign="top">
+           Ne pas ajouter de serveur de noms par défaut s'il n'y a pas de serveurs de noms dans le fichier <literal>resolv.conf</literal>.
+          </entry>
+         </row>
+        </tbody>
+       </tgroup>
+      </informaltable>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </refsect1>
- <refsect1 role="returnvalues">
-  &reftitle.returnvalues;
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   Si <parameter>initialize</parameter> a un type autre que
+   <type class="union"><type>int</type><type>bool</type></type>,
+   une <exceptionname>TypeError</exceptionname> est déclenchée.
+  </para>
+  <para>
+   Si la valeur de <parameter>initialize</parameter> est invalide,
+   une <exceptionname>EventException</exceptionname> est déclenchée.
+  </para>
+ </refsect1>
+ <refsect1 role="changelog">
+  &reftitle.changelog;
   <para>
-   Retourne un objet EventDnsBase.
+   <informaltable>
+    <tgroup cols="2">
+     <thead>
+      <row>
+       <entry>&Version;</entry>
+       <entry>&Description;</entry>
+      </row>
+     </thead>
+     <tbody>
+      <row>
+       <entry>PECL event 3.1.3</entry>
+       <entry>
+        Si <parameter>initialize</parameter> a un type autre que
+        <type class="union"><type>int</type><type>bool</type></type>,
+        une <exceptionname>TypeError</exceptionname> est déclenchée.
+       </entry>
+      </row>
+      <row>
+       <entry>PECL event 3.1.0RC1</entry>
+       <entry>
+        Le type du paramètre <parameter>initialize</parameter> a été changé de <type>bool</type>
+        à <type>mixed</type>. La valeur peut être soit <type>bool</type> (en préservant le sens précédent)
+        ou l'une des constantes suivantes:
+        <constant>EventDnsBase::DISABLE_WHEN_INACTIVE</constant>,
+        <constant>EventDnsBase::INITIALIZE_NAMESERVERS</constant>,
+        ou <constant>EventDnsBase::NAMESERVERS_NO_DEFAULT</constant>.
+       </entry>
+      </row>
+     </tbody>
+    </tgroup>
+   </informaltable>
   </para>
  </refsect1>
 </refentry>

diff --git a/reference/event/eventhttp/construct.xml b/reference/event/eventhttp/construct.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: af5f2f87b3b0bb9ee0f83ccb787a4e7db1eb6bd4 Maintainer: yannick Status: ready -->
+<!-- EN-Revision: 5cdfb2a044f9bcd5fed5c399de09edf7c89afd45 Maintainer: yannick Status: ready -->
 <!-- Reviewed: no -->
 
 <refentry xml:id="eventhttp.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
@@ -64,14 +64,6 @@
    </varlistentry>
   </variablelist>
  </refsect1>
-
- <refsect1 role="returnvalues">
-  &reftitle.returnvalues;
-  <para>
-   Retourne un objet <classname>EventHttp</classname>.
-  </para>
- </refsect1>
-
  <refsect1 role="changelog">
   &reftitle.changelog;
   <para>

diff --git a/reference/event/eventhttpconnection/construct.xml b/reference/event/eventhttpconnection/construct.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: af5f2f87b3b0bb9ee0f83ccb787a4e7db1eb6bd4 Maintainer: yannick Status: ready -->
+<!-- EN-Revision: b621ab27a9d333285df99a03825b36a87eb67cad Maintainer: yannick Status: ready -->
 <!-- Reviewed: no -->
 
 <refentry xml:id="eventhttpconnection.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
@@ -102,14 +102,6 @@
    </varlistentry>
   </variablelist>
  </refsect1>
-
- <refsect1 role="returnvalues">
-  &reftitle.returnvalues;
-  <para>
-   Retourne un objet <classname>EventHttpConnection</classname>.
-  </para>
- </refsect1>
-
  <refsect1 role="changelog">
   &reftitle.changelog;
   <para>