RecursiveArrayIterator::getChildren

Returns an iterator for the current entry if it is an array or an object

Description

public RecursiveArrayIteratornull RecursiveArrayIterator::getChildren()

Returns an iterator for the current iterator entry.

Parameters

This function has no parameters.

Return Values

An iterator for the current entry, if it is an array or object; or null on failure.

Errors/Exceptions

An InvalidArgumentException will be thrown if the current entry does not contain an array or an object.

Examples

Example #1 RecursiveArrayIterator::getChildren example

<?php
$fruits = array("a" => "lemon", "b" => "orange", array("a" => "apple", "p" => "pear"));

$iterator = new RecursiveArrayIterator($fruits);

while ($iterator->valid()) {

    if ($iterator->hasChildren()) {
        // print all children
        foreach ($iterator->getChildren() as $key => $value) {
            echo $key . ' : ' . $value . "\n";
        }
    } else {
        echo "No children.\n";
    }

    $iterator->next();
}
?>

The above example will output:

No children.
No children.
a : apple
p : pear