dba-popen.xml

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

<refentry xml:id="function.dba-popen" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>dba_popen</refname>
  <refpurpose>Ouvre une connexion persistante à une base de données DBA</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>Dba\Connection</type><type>false</type></type><methodname>dba_popen</methodname>
   <methodparam><type>string</type><parameter>path</parameter></methodparam>
   <methodparam><type>string</type><parameter>mode</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>handler</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>permission</parameter><initializer>0644</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>map_size</parameter><initializer>0</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>flags</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>dba_popen</function> établit une connexion persistante
   à la base repérée par <parameter>path</parameter>
   avec le mode <parameter>mode</parameter>, en utilisant l'identifiant
   <parameter>handler</parameter>.
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>path</parameter></term>
     <listitem>
      <para>
       Chemin sur votre système de fichiers.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>mode</parameter></term>
     <listitem>
      <para>
       Il vaut <literal>r</literal> pour lecture seule, <literal>w</literal> pour
       lecture/écriture, <literal>c</literal> pour lecture/écriture, et
       création si la base n'existe pas, et <literal>n</literal> pour
       création, écrasement, et accès en lecture/écriture. 
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>handler</parameter></term>
     <listitem>
      <para>
       Le nom du 
       <link linkend="dba.requirements">gestionnaire</link> qui doit être
       utilisé pour accéder à <parameter>path</parameter>. Le gestionnaire
       reçoit tous les paramètres supplémentaires passés à la fonction
       <function>dba_popen</function>. Si le paramètre <parameter>handler</parameter> est &null;,
       alors le gestionnaire par défaut est invoqué.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>permission</parameter></term>
     <listitem>
      <para>
       Paramètre optionnel de type entier (&integer;) qui est passé au pilote. Il a la même signification
       que le paramètre <parameter>permissions</parameter> de la fonction <function>chmod</function>,
       et sa valeur par défaut est <literal>0644</literal>.
      </para>
      <para>
       Les pilotes <literal>db1</literal>, <literal>db2</literal>,
       <literal>db3</literal>, <literal>db4</literal>, <literal>dbm</literal>,
       <literal>gdbm</literal>,
       <literal>ndbm</literal> et <literal>lmdb</literal> prennent en charge le paramètre
       <parameter>permission</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>map_size</parameter></term>
     <listitem>
      <para>
       Paramètre optionnel de type &integer; qui est passé au pilote. Sa valeur doit être un multiple de la
       taille de page du système d'exploitation, ou zéro pour utiliser la taille de mappe par défaut.
      </para>
      <para>
       Le pilote <literal>lmdb</literal> accepte le paramètre <parameter>map_size</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       Permet de passer des drapeaux aux pilotes de base de données. Actuellement, seul le pilote LMDB avec
       les drapeaux <constant>DBA_LMDB_USE_SUB_DIR</constant> et <constant>DBA_LMDB_NO_SUB_DIR</constant> est pris en charge.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne une instance <classname>Dba\Connection</classname> en cas de succès&return.falseforfailure;.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   La valeur &false; est renvoyée et une erreur de niveau <constant>E_WARNING</constant> est émise lorsque
   le paramètre <parameter>handler</parameter> est &null;, mais qu'aucun gestionnaire par défaut n'est disponible.
  </para>
 </refsect1>
 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
        <row>
          <entry>&Version;</entry>
          <entry>&Description;</entry>
        </row>
      </thead>
      <tbody>
        <row>
         <entry>8.4.0</entry>
         <entry>
          Retourne désormais une instance de <classname>Dba\Connection</classname>;
          auparavant, une &resource; était retournée.
         </entry>
        </row>
        <row>
         <entry>8.2.0</entry>
          <entry>
            Le paramètre <parameter>flags</parameter> a été ajouté.
          </entry>
        </row>
        <row>
          <entry>8.2.0</entry>
          <entry>
            Le paramètre <parameter>handler</parameter> est désormais nullable.
          </entry>
        </row>
        <row>
          <entry>7.3.14, 7.4.2</entry>
          <entry>
            Le pilote <literal>lmdb</literal> supporte désormais un paramètre
            additionel <parameter>map_size</parameter>.
          </entry>
        </row>
      </tbody>
    </tgroup>
  </informaltable>
 </refsect1> 

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>dba_open</function></member>
    <member><function>dba_close</function></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
-->