<!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 current key</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="simplexmliterator.haschildren.html">SimpleXMLIterator::hasChildren</a></div> <div class="next" style="text-align: right; float: right;"><a href="simplexmliterator.next.html">SimpleXMLIterator::next</a></div> <div class="up"><a href="class.simplexmliterator.html">SimpleXMLIterator</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="simplexmliterator.key" class="refentry"> <div class="refnamediv"> <h1 class="refname">SimpleXMLIterator::key</h1> <p class="verinfo">(PHP 5 >= 5.1.0)</p><p class="refpurpose"><span class="refname">SimpleXMLIterator::key</span> — <span class="dc-title">Return current key</span></p> </div> <div class="refsect1 description" id="refsect1-simplexmliterator.key-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><strong>SimpleXMLIterator::key</strong></span> ( <span class="methodparam">void</span> )</div> <p class="para rdfs-comment"> This method gets the XML tag name of the current element. </p> </div> <div class="refsect1 parameters" id="refsect1-simplexmliterator.key-parameters"> <h3 class="title">Parameters</h3> <p class="para">This function has no parameters.</p> </div> <div class="refsect1 returnvalues" id="refsect1-simplexmliterator.key-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns the XML tag name of the element referenced by the current <a href="class.simplexmliterator.html" class="classname">SimpleXMLIterator</a> object or <strong><code>FALSE</code></strong> </p> </div> <div class="refsect1 examples" id="refsect1-simplexmliterator.key-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-5516"> <p><strong>Example #1 Get the current XML tag key</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$xmlIterator </span><span style="color: #007700">= new </span><span style="color: #0000BB">SimpleXMLIterator</span><span style="color: #007700">(</span><span style="color: #DD0000">'<books><book>PHP basics</book><book>XML basics</book></books>'</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$xmlIterator</span><span style="color: #007700">-></span><span style="color: #0000BB">key</span><span style="color: #007700">());<br /></span><span style="color: #0000BB">$xmlIterator</span><span style="color: #007700">-></span><span style="color: #0000BB">rewind</span><span style="color: #007700">(); </span><span style="color: #FF8000">// rewind to the first element<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$xmlIterator</span><span style="color: #007700">-></span><span style="color: #0000BB">key</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:</p></div> <div class="example-contents screen"> <div class="cdata"><pre> bool(false) string(4) "book" </pre></div> </div> </div> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="simplexmliterator.haschildren.html">SimpleXMLIterator::hasChildren</a></div> <div class="next" style="text-align: right; float: right;"><a href="simplexmliterator.next.html">SimpleXMLIterator::next</a></div> <div class="up"><a href="class.simplexmliterator.html">SimpleXMLIterator</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>