<!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>Returns an iterator for the current entry if it is an array or an object.</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.recursivearrayiterator.html">RecursiveArrayIterator</a></div>
<div class="next" style="text-align: right; float: right;"><a href="recursivearrayiterator.haschildren.html">RecursiveArrayIterator::hasChildren</a></div>
<div class="up"><a href="class.recursivearrayiterator.html">RecursiveArrayIterator</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="recursivearrayiterator.getchildren" class="refentry">
<div class="refnamediv">
<h1 class="refname">RecursiveArrayIterator::getChildren</h1>
<p class="verinfo">(PHP 5 >= 5.1.0)</p><p class="refpurpose"><span class="refname">RecursiveArrayIterator::getChildren</span> — <span class="dc-title">Returns an iterator for the current entry if it is an <span class="type"><a href="language.types.array.html" class="type array">array</a></span> or an <span class="type"><a href="language.types.object.html" class="type object">object</a></span>.</span></p>
</div>
<div class="refsect1 description" id="refsect1-recursivearrayiterator.getchildren-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><a href="class.recursivearrayiterator.html" class="type RecursiveArrayIterator">RecursiveArrayIterator</a></span> <span class="methodname"><strong>RecursiveArrayIterator::getChildren</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
Returns an iterator for the current iterator entry.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-recursivearrayiterator.getchildren-parameters">
<h3 class="title">Parameters</h3>
<p class="para">This function has no parameters.</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-recursivearrayiterator.getchildren-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
An iterator for the current entry, if it is an <span class="type"><a href="language.types.array.html" class="type array">array</a></span> or <span class="type"><a href="language.types.object.html" class="type object">object</a></span>.
</p>
</div>
<div class="refsect1 errors" id="refsect1-recursivearrayiterator.getchildren-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
An <a href="class.invalidargumentexception.html" class="classname">InvalidArgumentException</a>
will be thrown if the current entry does not contain an <span class="type"><a href="language.types.array.html" class="type array">array</a></span> or an <span class="type"><a href="language.types.object.html" class="type object">object</a></span>.
</p>
</div>
<div class="refsect1 examples" id="refsect1-recursivearrayiterator.getchildren-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3889">
<p><strong>Example #1 <span class="function"><strong>RecursiveArrayIterator::getChildren()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$fruits </span><span style="color: #007700">= array(</span><span style="color: #DD0000">"a" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"lemon"</span><span style="color: #007700">, </span><span style="color: #DD0000">"b" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"orange"</span><span style="color: #007700">, array(</span><span style="color: #DD0000">"a" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"apple"</span><span style="color: #007700">, </span><span style="color: #DD0000">"p" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"pear"</span><span style="color: #007700">));<br /><br /></span><span style="color: #0000BB">$iterator </span><span style="color: #007700">= new </span><span style="color: #0000BB">RecursiveArrayIterator</span><span style="color: #007700">(</span><span style="color: #0000BB">$fruits</span><span style="color: #007700">);<br /><br />while (</span><span style="color: #0000BB">$iterator</span><span style="color: #007700">-></span><span style="color: #0000BB">valid</span><span style="color: #007700">()) {<br /><br /> if (</span><span style="color: #0000BB">$iterator</span><span style="color: #007700">-></span><span style="color: #0000BB">hasChildren</span><span style="color: #007700">()) {<br /> </span><span style="color: #FF8000">// print all children<br /> </span><span style="color: #007700">foreach (</span><span style="color: #0000BB">$iterator</span><span style="color: #007700">-></span><span style="color: #0000BB">getChildren</span><span style="color: #007700">() as </span><span style="color: #0000BB">$key </span><span style="color: #007700">=> </span><span style="color: #0000BB">$value</span><span style="color: #007700">) {<br /> echo </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">$value </span><span style="color: #007700">. </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /> }<br /> } else {<br /> echo </span><span style="color: #DD0000">"No children.\n"</span><span style="color: #007700">;<br /> }<br /><br /> </span><span style="color: #0000BB">$iterator</span><span style="color: #007700">-></span><span style="color: #0000BB">next</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>
No children.
No children.
a : apple
p : pear
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-recursivearrayiterator.getchildren-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="recursivearrayiterator.haschildren.html" class="function" rel="rdfs-seeAlso">RecursiveArrayIterator::hasChildren()</a> - Returns whether current entry is an array or an object.</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="class.recursivearrayiterator.html">RecursiveArrayIterator</a></div>
<div class="next" style="text-align: right; float: right;"><a href="recursivearrayiterator.haschildren.html">RecursiveArrayIterator::hasChildren</a></div>
<div class="up"><a href="class.recursivearrayiterator.html">RecursiveArrayIterator</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
