<!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>Return the key for the current DirectoryIterator item</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="directoryiterator.iswritable.html">DirectoryIterator::isWritable</a></div>
<div class="next" style="text-align: right; float: right;"><a href="directoryiterator.next.html">DirectoryIterator::next</a></div>
<div class="up"><a href="class.directoryiterator.html">DirectoryIterator</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="directoryiterator.key" class="refentry">
<div class="refnamediv">
<h1 class="refname">DirectoryIterator::key</h1>
<p class="verinfo">(PHP 5)</p><p class="refpurpose"><span class="refname">DirectoryIterator::key</span> — <span class="dc-title">Return the key for the current DirectoryIterator item</span></p>
</div>
<div class="refsect1 description" id="refsect1-directoryiterator.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>DirectoryIterator::key</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
Get the key for the current <a href="class.directoryiterator.html" class="classname">DirectoryIterator</a> item.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-directoryiterator.key-parameters">
<h3 class="title">Parameters</h3>
<p class="para">This function has no parameters.</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-directoryiterator.key-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
The key for the current <a href="class.directoryiterator.html" class="classname">DirectoryIterator</a> item.
</p>
</div>
<div class="refsect1 examples" id="refsect1-directoryiterator.key-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3867">
<p><strong>Example #1 A <span class="methodname"><strong>DirectoryIterator::key()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$dir </span><span style="color: #007700">= new </span><span style="color: #0000BB">DirectoryIterator</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">));<br />foreach (</span><span style="color: #0000BB">$dir </span><span style="color: #007700">as </span><span style="color: #0000BB">$fileinfo</span><span style="color: #007700">) {<br /> if (!</span><span style="color: #0000BB">$fileinfo</span><span style="color: #007700">-></span><span style="color: #0000BB">isDot</span><span style="color: #007700">()) {<br /> echo </span><span style="color: #0000BB">$fileinfo</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">$fileinfo</span><span style="color: #007700">-></span><span style="color: #0000BB">getFilename</span><span style="color: #007700">() . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /> }<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 => apple.jpg
1 => banana.jpg
2 => index.php
3 => pear.jpg
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-directoryiterator.key-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="directoryiterator.current.html" class="methodname" rel="rdfs-seeAlso">DirectoryIterator::current()</a> - Return the current DirectoryIterator item.</span></li>
<li class="member"> <span class="methodname"><a href="directoryiterator.next.html" class="methodname" rel="rdfs-seeAlso">DirectoryIterator::next()</a> - Move forward to next DirectoryIterator item</span></li>
<li class="member"> <span class="methodname"><a href="directoryiterator.rewind.html" class="methodname" rel="rdfs-seeAlso">DirectoryIterator::rewind()</a> - Rewind the DirectoryIterator back to the start</span></li>
<li class="member"> <span class="methodname"><a href="directoryiterator.valid.html" class="methodname" rel="rdfs-seeAlso">DirectoryIterator::valid()</a> - Check whether current DirectoryIterator position is a valid file</span></li>
<li class="member"> <span class="methodname"><a href="iterator.key.html" class="methodname" rel="rdfs-seeAlso">Iterator::key()</a> - Return the key of the current element</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="directoryiterator.iswritable.html">DirectoryIterator::isWritable</a></div>
<div class="next" style="text-align: right; float: right;"><a href="directoryiterator.next.html">DirectoryIterator::next</a></div>
<div class="up"><a href="class.directoryiterator.html">DirectoryIterator</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
