<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <title>Tests for end-of-file on a file pointer</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="streamwrapper.stream-close.html">streamWrapper::stream_close</a></div> <div class="next" style="text-align: right; float: right;"><a href="streamwrapper.stream-flush.html">streamWrapper::stream_flush</a></div> <div class="up"><a href="class.streamwrapper.html">streamWrapper</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="streamwrapper.stream-eof" class="refentry"> <div class="refnamediv"> <h1 class="refname">streamWrapper::stream_eof</h1> <p class="verinfo">(PHP 4 >= 4.3.2, PHP 5)</p><p class="refpurpose"><span class="refname">streamWrapper::stream_eof</span> — <span class="dc-title">Tests for end-of-file on a file pointer</span></p> </div> <div class="refsect1 description" id="refsect1-streamwrapper.stream-eof-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>streamWrapper::stream_eof</strong></span> ( <span class="methodparam">void</span> )</div> <p class="para rdfs-comment"> This method is called in response to <span class="function"><a href="function.feof.html" class="function">feof()</a></span>. </p> </div> <div class="refsect1 parameters" id="refsect1-streamwrapper.stream-eof-parameters"> <h3 class="title">Parameters</h3> <p class="para">This function has no parameters.</p> </div> <div class="refsect1 returnvalues" id="refsect1-streamwrapper.stream-eof-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Should return <strong><code>TRUE</code></strong> if the read/write position is at the end of the stream and if no more data is available to be read, or <strong><code>FALSE</code></strong> otherwise. </p> </div> <div class="refsect1 notes" id="refsect1-streamwrapper.stream-eof-notes"> <h3 class="title">Notes</h3> <div class="warning"><strong class="warning">Warning</strong> <p class="para"> When reading the whole file (for example, with <span class="function"><a href="function.file-get-contents.html" class="function">file_get_contents()</a></span>), PHP will call <span class="methodname"><a href="streamwrapper.stream-read.html" class="methodname">streamWrapper::stream_read()</a></span> followed by <span class="methodname"><strong>streamWrapper::stream_eof()</strong></span> in a loop but as long as <span class="methodname"><a href="streamwrapper.stream-read.html" class="methodname">streamWrapper::stream_read()</a></span> returns a non-empty string, the return value of <span class="methodname"><strong>streamWrapper::stream_eof()</strong></span> is ignored. </p> </div> </div> <div class="refsect1 seealso" id="refsect1-streamwrapper.stream-eof-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="function"><a href="function.feof.html" class="function" rel="rdfs-seeAlso">feof()</a> - Tests for end-of-file on a file pointer</span></li> </ul> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="streamwrapper.stream-close.html">streamWrapper::stream_close</a></div> <div class="next" style="text-align: right; float: right;"><a href="streamwrapper.stream-flush.html">streamWrapper::stream_flush</a></div> <div class="up"><a href="class.streamwrapper.html">streamWrapper</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>