<!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 the registered iterator instances</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="multipleiterator.getflags.html">MultipleIterator::getFlags</a></div> <div class="next" style="text-align: right; float: right;"><a href="multipleiterator.next.html">MultipleIterator::next</a></div> <div class="up"><a href="class.multipleiterator.html">MultipleIterator</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="multipleiterator.key" class="refentry"> <div class="refnamediv"> <h1 class="refname">MultipleIterator::key</h1> <p class="verinfo">(PHP 5 >= 5.3.0)</p><p class="refpurpose"><span class="refname">MultipleIterator::key</span> — <span class="dc-title">Gets the registered iterator instances</span></p> </div> <div class="refsect1 description" id="refsect1-multipleiterator.key-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><strong>MultipleIterator::key</strong></span> ( <span class="methodparam">void</span> )</div> <p class="para rdfs-comment"> Get the registered iterator instances key() result. </p> <div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function is currently not documented; only its argument list is available. </p></div> </div> <div class="refsect1 parameters" id="refsect1-multipleiterator.key-parameters"> <h3 class="title">Parameters</h3> <p class="para">This function has no parameters.</p> </div> <div class="refsect1 returnvalues" id="refsect1-multipleiterator.key-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> An <span class="type"><a href="language.types.array.html" class="type array">array</a></span> of all registered iterator instances, or <strong><code>FALSE</code></strong> if no sub iterator is attached. </p> </div> <div class="refsect1 errors" id="refsect1-multipleiterator.key-errors"> <h3 class="title">Errors/Exceptions</h3> <p class="para"> A <a href="class.logicexception.html" class="classname">LogicException</a> if mode <strong><code>MIT_NEED_ALL</code></strong> is set, and at least one attached iterator is not valid. </p> <p class="para"> Calling this method from <a href="control-structures.foreach.html" class="xref">foreach</a> triggers warning "Illegal type returned". </p> </div> <div class="refsect1 seealso" id="refsect1-multipleiterator.key-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="methodname"><a href="multipleiterator.current.html" class="methodname" rel="rdfs-seeAlso">MultipleIterator::current()</a> - Gets the registered iterator instances</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="multipleiterator.getflags.html">MultipleIterator::getFlags</a></div> <div class="next" style="text-align: right; float: right;"><a href="multipleiterator.next.html">MultipleIterator::next</a></div> <div class="up"><a href="class.multipleiterator.html">MultipleIterator</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>