<!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>Retrieve the key for the current file</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="filesystemiterator.getflags.html">FilesystemIterator::getFlags</a></div> <div class="next" style="text-align: right; float: right;"><a href="filesystemiterator.next.html">FilesystemIterator::next</a></div> <div class="up"><a href="class.filesystemiterator.html">FilesystemIterator</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="filesystemiterator.key" class="refentry"> <div class="refnamediv"> <h1 class="refname">FilesystemIterator::key</h1> <p class="verinfo">(PHP 5 >= 5.3.0)</p><p class="refpurpose"><span class="refname">FilesystemIterator::key</span> — <span class="dc-title">Retrieve the key for the current file</span></p> </div> <div class="refsect1 description" id="refsect1-filesystemiterator.key-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>FilesystemIterator::key</strong></span> ( <span class="methodparam">void</span> )</div> </div> <div class="refsect1 parameters" id="refsect1-filesystemiterator.key-parameters"> <h3 class="title">Parameters</h3> <p class="para">This function has no parameters.</p> </div> <div class="refsect1 returnvalues" id="refsect1-filesystemiterator.key-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns the pathname or filename depending on the set flags. See the <a href="class.filesystemiterator.html#filesystemiterator.constants" class="link">FilesystemIterator constants</a>. </p> </div> <div class="refsect1 examples" id="refsect1-filesystemiterator.key-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-3875"> <p><strong>Example #1 <span class="methodname"><strong>FilesystemIterator::key()</strong></span> example</strong></p> <div class="example-contents"><p> This example will list the contents of the directory containing the script. </p></div> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$iterator </span><span style="color: #007700">= new </span><span style="color: #0000BB">FilesystemIterator</span><span style="color: #007700">(</span><span style="color: #0000BB">dirname</span><span style="color: #007700">(</span><span style="color: #0000BB">__FILE__</span><span style="color: #007700">), </span><span style="color: #0000BB">FilesystemIterator</span><span style="color: #007700">::</span><span style="color: #0000BB">KEY_AS_FILENAME</span><span style="color: #007700">);<br />foreach (</span><span style="color: #0000BB">$iterator </span><span style="color: #007700">as </span><span style="color: #0000BB">$fileinfo</span><span style="color: #007700">) {<br /> echo </span><span style="color: #0000BB">$iterator</span><span style="color: #007700">-></span><span style="color: #0000BB">key</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> apple.jpg banana.jpg example.php </pre></div> </div> </div> </p> </div> <div class="refsect1 seealso" id="refsect1-filesystemiterator.key-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"><a href="class.filesystemiterator.html#filesystemiterator.constants" class="link">FilesystemIterator constants</a></li> <li class="member"> <span class="methodname"><a href="directoryiterator.key.html" class="methodname" rel="rdfs-seeAlso">DirectoryIterator::key()</a> - Return the key for the current DirectoryIterator item</span></li> <li class="member"> <span class="methodname"><a href="directoryiterator.getfilename.html" class="methodname" rel="rdfs-seeAlso">DirectoryIterator::getFilename()</a> - Return file name of current DirectoryIterator item.</span></li> <li class="member"> <span class="methodname"><a href="directoryiterator.getpathname.html" class="methodname" rel="rdfs-seeAlso">DirectoryIterator::getPathname()</a> - Return path and file name of current DirectoryIterator item</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="filesystemiterator.getflags.html">FilesystemIterator::getFlags</a></div> <div class="next" style="text-align: right; float: right;"><a href="filesystemiterator.next.html">FilesystemIterator::next</a></div> <div class="up"><a href="class.filesystemiterator.html">FilesystemIterator</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>