<!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>Gets line from file</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="splfileobject.fgetcsv.html">SplFileObject::fgetcsv</a></div>
<div class="next" style="text-align: right; float: right;"><a href="splfileobject.fgetss.html">SplFileObject::fgetss</a></div>
<div class="up"><a href="class.splfileobject.html">SplFileObject</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="splfileobject.fgets" class="refentry">
<div class="refnamediv">
<h1 class="refname">SplFileObject::fgets</h1>
<p class="verinfo">(PHP 5 >= 5.1.0)</p><p class="refpurpose"><span class="refname">SplFileObject::fgets</span> — <span class="dc-title">Gets line from file</span></p>
</div>
<div class="refsect1 description" id="refsect1-splfileobject.fgets-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><strong>SplFileObject::fgets</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
Gets a line from the file.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-splfileobject.fgets-parameters">
<h3 class="title">Parameters</h3>
<p class="para">This function has no parameters.</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-splfileobject.fgets-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a string containing the next line from the file, or <strong><code>FALSE</code></strong> on error.
</p>
</div>
<div class="refsect1 errors" id="refsect1-splfileobject.fgets-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Throws a <a href="class.runtimeexception.html" class="classname">RuntimeException</a> if the file cannot be read.
</p>
</div>
<div class="refsect1 examples" id="refsect1-splfileobject.fgets-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3953">
<p><strong>Example #1 <span class="methodname"><strong>SplFileObject::fgets()</strong></span> example</strong></p>
<div class="example-contents"><p>This example simply outputs the contents of <em>file.txt</em> line-by-line.</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$file </span><span style="color: #007700">= new </span><span style="color: #0000BB">SplFileObject</span><span style="color: #007700">(</span><span style="color: #DD0000">"file.txt"</span><span style="color: #007700">);<br />while (!</span><span style="color: #0000BB">$file</span><span style="color: #007700">-></span><span style="color: #0000BB">eof</span><span style="color: #007700">()) {<br /> echo </span><span style="color: #0000BB">$file</span><span style="color: #007700">-></span><span style="color: #0000BB">fgets</span><span style="color: #007700">();<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-splfileobject.fgets-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.fgets.html" class="function" rel="rdfs-seeAlso">fgets()</a> - Gets line from file pointer</span></li>
<li class="member"> <span class="methodname"><a href="splfileobject.fgetss.html" class="methodname" rel="rdfs-seeAlso">SplFileObject::fgetss()</a> - Gets line from file and strip HTML tags</span></li>
<li class="member"> <span class="methodname"><a href="splfileobject.fgetc.html" class="methodname" rel="rdfs-seeAlso">SplFileObject::fgetc()</a> - Gets character from file</span></li>
<li class="member"> <span class="methodname"><a href="splfileobject.current.html" class="methodname" rel="rdfs-seeAlso">SplFileObject::current()</a> - Retrieve current line of file</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="splfileobject.fgetcsv.html">SplFileObject::fgetcsv</a></div>
<div class="next" style="text-align: right; float: right;"><a href="splfileobject.fgetss.html">SplFileObject::fgetss</a></div>
<div class="up"><a href="class.splfileobject.html">SplFileObject</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
