add RecursiveIteratorAggregateIterator

[mastir]

One more missing iterator.

I made it to travel deep tree Traversable structure without RecursiveIterator interface

[what-the-diff]

PR Summary

• Introduction of New Recursive Iterator Class
  A new class called 'RecursiveIteratorAggregateIterator' has been created and included in a new file. This class is designed to handle how lists or other sets of data are stepped through, especially if these sets contain other nested sets.
• Unit Test for New Recursive Iterator Class
  To validate the functionality of the new Recursive Iterator class, a series of unit tests have been created and captured in a file called 'RecursiveIteratorAggregateIteratorTest'.
• Expansion of Unit Test to Cover New Cases
  The already-existing 'RecursiveIteratorAggregateIteratorTest' was updated to include a new case called 'testRecursiveIteratorAggregateIterator'. This additional test is designed to ensure that the new class correctly handles a series of nested objects.

[drupol]

hey hi first contributor!

Thanks for the PR! Can you please fix the static analysis issue and code style?

Once it's done, I'll review it manually.

Thanks again!

[drupol]

end() is a $\mathcal{O}(n)$ operation, it may be slow, let's try to call it once here.

[mastir]

We can simple have last $iterator outside of a $stack to avoid array operations

[drupol]

Not need to have a static function self::findIterator, let's remove the static from it.

[drupol]

Let's keep the object immutable, this should not happen

[mastir]

We can`t have state tracking (getDepth) on immutable iterator, we can add exception here

[drupol]

The getDepth method is not part of the IteratorAggregate interface, I would remove it.

[mastir]

getDepth method is required for tree travel

[drupol]

Then it should be private.

[mastir]

It`s not used by iterator, its required to detect depth (or move direction) in loop. Like

foreach($it as $val){
   echo str_repeat('-', $it->getDepth()).$val."\n";
}

[drupol]

yes I noticed it after your message. Since that method is not part of the interface, I would make it private.

[mastir]

Or more common use case for xml/html/whatever

$prev_depth = 0;
foreach($it as $val){
   $next_depth = $it->getDepth();
   if ($prev_depth < $next_depth) echo "<tag>\n";
   for($i=$prev_depth;$i>$next_depth;$i--) echo "</tag>\n";
   echo $val;
   $prev_depth = $next_depth;
}
for($i=$prev_depth;$i>0;$i--) echo "</tag>\n";

[mastir]

private method cannot be called outside of the iterator class (including foreach loop). It`s simple useless

[drupol]

This cannot happen. This method always returns a new iterator, ready to be consumed.

[mastir]

foreach($it as $a){ //generator assign stack to iterator
    foreach($it as $b){ //same iterator, new stack will replace original, throw exception
    }
}

[drupol]

What are you trying to tell me here?

[mastir]

Exception will be thrown in this case

[drupol]

Does this PR is similar to #61 ?

[mastir]

Yes, #61 has same logic, but for different structeres. this iterator provides recursive iteration over tree-like structure of objects implementing Itrator or IteratorArgregate interface. RecursiveIterableAggregate in #61 adds iteration over traversable tree-like structures (like deep array or array of object tree).

[github-actions]

Since this pull request has not had any activity within the last 5 days, I have marked it as stale.
I will close it if no further activity occurs within the next 5 days.