php-doc-en/reference/filesystem/functions/feof.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.16 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.feof">
 <refnamediv>
  <refname>feof</refname>
  <refpurpose>Tests for end-of-file on a file pointer</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>feof</methodname>
   <methodparam><type>resource</type><parameter>handle</parameter></methodparam>
  </methodsynopsis>
  <para>
   Tests for end-of-file on a file pointer.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>handle</parameter></term>
     <listitem>
      &fs.validfp.all;
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns &true; if the file pointer is at EOF or an error occurs
   (including socket timeout); otherwise returns &false;.
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <warning>
   <simpara>
    If a connection opened by <function>fsockopen</function> wasn't closed
    by the server, <function>feof</function> will wait until a timeout has
    been reached to return &true;. The default timeout value is 60 seconds.
    You may use <function>stream_set_timeout</function> to change this
    value.
   </simpara>
  </warning>
  <warning>
   <para>
    If passed file pointer is not valid you may get an infinite loop, because
    EOF fails to return TRUE.
    <example>
     <title><function>feof</function> example with an invalid file pointer</title>
     <programlisting role="php">
 <![CDATA[
<?php
// if file can not be read or doesn't exist fopen function returns FALSE
$file = @fopen("no_such_file", "r");

// FALSE from fopen will issue warning and result in infinite loop here
while (!feof($file)) {
}

fclose($file);
?>
]]>
     </programlisting>
    </example>
   </para>
  </warning>
 </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:"../../../../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
-->