doc-fr/reference/eio/functions/eio-open.xml

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

<refentry xml:id="function.eio-open" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>eio_open</refname>
  <refpurpose>Ouvre un fichier</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>eio_open</methodname>
   <methodparam><type>string</type><parameter>path</parameter></methodparam>
   <methodparam><type>int</type><parameter>flags</parameter></methodparam>
   <methodparam><type>int</type><parameter>mode</parameter></methodparam>
   <methodparam><type>int</type><parameter>pri</parameter></methodparam>
   <methodparam><type>callable</type><parameter>callback</parameter></methodparam>
   <methodparam
   choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>eio_open</function> ouvre un fichier spécifié par l'argument
   <parameter>path</parameter> avec le mode d'accès spécifié par
   l'argument<parameter>mode</parameter>.
  </para>
  
  
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>path</parameter></term>
    <listitem>
     <para>
      Chemin vers le fichier à ouvrir.
      <warning>
       <simpara>
        Avec quelques APIs (i.e. <emphasis>PHP-FPM</emphasis>), l'appel
        peut échouer si vous ne spécifiez pas le chemin complet.
       </simpara>
      </warning>
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>flags</parameter></term>
    <listitem>
     <para>
      Une constante parmi les constants <emphasis>EIO_O_*</emphasis>,
      ou bien une combinaison de ces constantes. Les constantes
      <emphasis>EIO_O_*</emphasis> ont la même signification que les
      constantes correspondantes <emphasis>O_*</emphasis> définies dans
      le fichier d'en-têtes C <literal>fnctl.h</literal>. Par défaut, vaut
      <constant>EIO_O_RDWR</constant>.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>mode</parameter></term>
    <listitem>
     <para>
      Une constante parmi les constantes <emphasis>EIO_S_I*</emphasis>, ou bien
      une combinaison de ces constantes (via l'opérateur OR).
      Les constantes ont la même signification que les constantes correspondantes
      <emphasis>S_I*</emphasis> définies dans le fichier d'en-têtes C <link
      xlink:href="http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/sys_stat.h.html">sys/stat.h</link>.
      Requis si un fichier est créé. Sinon, il sera ignoré.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>pri</parameter></term>
    <listitem>
     &eio.request.pri.values;
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>callback</parameter></term>
    <listitem>
     &eio.callback.proto;
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>data</parameter></term>
    <listitem>
     <para>
      Variables arbitraires à passer à la fonction de rappel
      <parameter>callback</parameter>.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <function>eio_open</function> retourne un descripteur de fichier
   dans l'argument <parameter>result</parameter> de la fonction de
   rappel <parameter>callback</parameter> en cas de succès ;
   sinon, <parameter>result</parameter> vaudra <constant>-1</constant>.
  </para>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Exempe avec <function>eio_open</function></title>
   <programlisting role="php">
<![CDATA[
<?php
$temp_filename = "eio-temp-file.tmp";

/* Sera appelé lorsque la fonction eio_close() aura terminé */
function my_close_cb($data, $result) {
 // Zéro indique une exécution avec succès
    var_dump($result == 0);
 @unlink($data);
}

/* Sera appelé lorsque la fonction eio_open() aura terminé */
function my_file_opened_callback($data, $result) {
 // $result doit contenir le descripteur de fichier
    var_dump($result > 0);

    if ($result > 0) {
  // Ferme le fichier
        eio_close($result, EIO_PRI_DEFAULT, "my_close_cb", $data);
        eio_event_loop();
    }
}

// Crée un nouveau fichier pour lecture et écriture
// N'autorise pas les groupes et autres à faire ce que ce soit avec ce fichier
eio_open($temp_filename, EIO_O_CREAT | EIO_O_RDWR, EIO_S_IRUSR | EIO_S_IWUSR,
  EIO_PRI_DEFAULT, "my_file_opened_callback", $temp_filename);
eio_event_loop();
?>
]]>
   </programlisting>
   &example.outputs.similar;
   <screen>
<![CDATA[
bool(true)
bool(true)
]]>
   </screen>
  </example>
 </refsect1>


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