stream-eof.xml

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

<refentry xml:id="streamwrapper.stream-eof" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>streamWrapper::stream_eof</refname>
  <refpurpose>Tests for end-of-file on a file pointer</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type>bool</type><methodname>streamWrapper::stream_eof</methodname>
   <void />
  </methodsynopsis>
  <para>
   Cette méthode est appelée en réponse à <function>feof</function>.
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Doit retourner &true; si le curseur est à la fin du flux, et 
   que plus aucune donnée n'est disponible, et 
   &false; sinon.
  </para>
 </refsect1>
 
 <refsect1 role="notes"><!-- {{{ -->
  &reftitle.notes;
  <warning>
   <para>
    Lors de la lecture complète d'un fichier (par exemple, par
    la fonction <function>file_get_contents</function>), PHP
    appellera la fonction <methodname>streamWrapper::stream_read</methodname>
    suivie de la fonction <methodname>streamWrapper::stream_eof</methodname>
    dans une boucle, mais tant que la fonction
    <methodname>streamWrapper::stream_read</methodname> retournera une
    chaîne non vide, la valeur retournée de la fonction
    <methodname>streamWrapper::stream_eof</methodname> sera ignorée.
   </para>
  </warning>
 </refsect1><!-- }}} -->
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>feof</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
-->