<!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>Get line number</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="splfileobject.haschildren.html">SplFileObject::hasChildren</a></div> <div class="next" style="text-align: right; float: right;"><a href="splfileobject.next.html">SplFileObject::next</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.key" class="refentry"> <div class="refnamediv"> <h1 class="refname">SplFileObject::key</h1> <p class="verinfo">(PHP 5 >= 5.1.0)</p><p class="refpurpose"><span class="refname">SplFileObject::key</span> — <span class="dc-title">Get line number</span></p> </div> <div class="refsect1 description" id="refsect1-splfileobject.key-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><strong>SplFileObject::key</strong></span> ( <span class="methodparam">void</span> )</div> <p class="para rdfs-comment"> Gets the current line number. </p> <blockquote class="note"><p><strong class="note">Note</strong>: <p class="para"> This number may not reflect the actual line number in the file if <span class="methodname"><a href="splfileobject.setmaxlinelen.html" class="methodname">SplFileObject::setMaxLineLen()</a></span> is used to read fixed lengths of the file. </p> </p></blockquote> </div> <div class="refsect1 parameters" id="refsect1-splfileobject.key-parameters"> <h3 class="title">Parameters</h3> <p class="para">This function has no parameters.</p> </div> <div class="refsect1 returnvalues" id="refsect1-splfileobject.key-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns the current line number. </p> </div> <div class="refsect1 examples" id="refsect1-splfileobject.key-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-3967"> <p><strong>Example #1 <span class="methodname"><strong>SplFileObject::key()</strong></span> example</strong></p> <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">"lipsum.txt"</span><span style="color: #007700">);<br />foreach (</span><span style="color: #0000BB">$file </span><span style="color: #007700">as </span><span style="color: #0000BB">$line</span><span style="color: #007700">) {<br /> echo </span><span style="color: #0000BB">$file</span><span style="color: #007700">-></span><span style="color: #0000BB">key</span><span style="color: #007700">() . </span><span style="color: #DD0000">". " </span><span style="color: #007700">. </span><span style="color: #0000BB">$line</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> <div class="example-contents"><p>The above example will output something similar to:</p></div> <div class="example-contents screen"> <div class="cdata"><pre> 0. Lorem ipsum dolor sit amet, consectetur adipiscing elit. 1. Duis nec sapien felis, ac sodales nisl. 2. Lorem ipsum dolor sit amet, consectetur adipiscing elit. </pre></div> </div> </div> </p> <p class="para"> <div class="example" id="example-3968"> <p><strong>Example #2 <span class="methodname"><strong>SplFileObject::key()</strong></span> example with <span class="methodname"><a href="splfileobject.setmaxlinelen.html" class="methodname">SplFileObject::setMaxLineLen()</a></span></strong></p> <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">"lipsum.txt"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$file</span><span style="color: #007700">-></span><span style="color: #0000BB">setMaxLineLen</span><span style="color: #007700">(</span><span style="color: #0000BB">20</span><span style="color: #007700">);<br />foreach (</span><span style="color: #0000BB">$file </span><span style="color: #007700">as </span><span style="color: #0000BB">$line</span><span style="color: #007700">) {<br /> echo </span><span style="color: #0000BB">$file</span><span style="color: #007700">-></span><span style="color: #0000BB">key</span><span style="color: #007700">() . </span><span style="color: #DD0000">". " </span><span style="color: #007700">. </span><span style="color: #0000BB">$line </span><span style="color: #007700">. </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> <div class="example-contents"><p>The above example will output something similar to:</p></div> <div class="example-contents screen"> <div class="cdata"><pre> 0. Lorem ipsum dolor s 1. it amet, consectetu 2. r adipiscing elit. 3. 4. Duis nec sapien fel 5. is, ac sodales nisl 6. . 7. Lorem ipsum dolor s 8. it amet, consectetu 9. r adipiscing elit. </pre></div> </div> </div> </p> </div> <div class="refsect1 seealso" id="refsect1-splfileobject.key-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <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> <li class="member"> <span class="methodname"><a href="splfileobject.seek.html" class="methodname" rel="rdfs-seeAlso">SplFileObject::seek()</a> - Seek to specified line</span></li> <li class="member"> <span class="methodname"><a href="splfileobject.next.html" class="methodname" rel="rdfs-seeAlso">SplFileObject::next()</a> - Read next line</span></li> <li class="member"> <span class="methodname"><a href="splfileobject.rewind.html" class="methodname" rel="rdfs-seeAlso">SplFileObject::rewind()</a> - Rewind the file to the first line</span></li> <li class="member"> <span class="methodname"><a href="splfileobject.valid.html" class="methodname" rel="rdfs-seeAlso">SplFileObject::valid()</a> - Not at EOF</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.haschildren.html">SplFileObject::hasChildren</a></div> <div class="next" style="text-align: right; float: right;"><a href="splfileobject.next.html">SplFileObject::next</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>