RecursiveRegexIterator::getChildren

(PHP 5 >= 5.2.0, PHP 7)

Returns an iterator for the current entry.

public RecursiveRegexIterator RecursiveRegexIterator::getChildren ( void )

Returns an iterator for the current iterator entry.

Returns:

An iterator for the current entry, if it can be iterated over by the inner iterator.

Exception:

An InvalidArgumentException will be thrown if the current entry does not contain a value that can be iterated over by the inner iterator.

Examples:

RecursiveRegexIterator::getChildren() example

<?php
$rArrayIterator = new RecursiveArrayIterator(array('test1', array('tet3', 'test4', 'test5')));
$rRegexIterator = new RecursiveRegexIterator($rArrayIterator, '/^test/',
    RecursiveRegexIterator::ALL_MATCHES);
 
foreach ($rRegexIterator as $key1 => $value1) {
 
    if ($rRegexIterator->hasChildren()) {
 
        // print all children
        echo "Children: ";
        foreach ($rRegexIterator->getChildren() as $key => $value) {
            echo $value . " ";
        }
        echo "\n";
    } else {
        echo "No children\n";
    }
 
}
?>

The above example will output:

No children
Children: test4 test5