Are Multiple Iterators possible in php?

Question

PLEASE CHECK ANSWERS by VolkerK too, he provided another solution, but I can't mark two posts as answer. :(

Good day!

I know that C# allows multiple iterators using yield, like described here: Is Multiple Iterators is possible in c#?

In PHP there is and Iterator interface. Is it possible to implement more than one iteration scenario for a class?

More details (EDIT):

For example I have class TreeNode implementing single tree node. The whole tree can be expressed using only one this class. I want to provide iterators for iterating all direct and indirect children of current node, for example using BreadthFirst or DepthFirst order.

I can implement this Iterators as separate classes but doing so I need that tree node should expose it's children collection as public.

C# pseudocode:

 public class TreeNode<T> 
  {
  ...
     public IEnumerable<T> DepthFirstEnumerator
     {
         get
        {
            // Some tree traversal using 'yield return'
        }
     }

     public IEnumerable<T> BreadthFirstEnumerator
     {
         get
         {
             // Some tree traversal using 'yield return'
         }
     }
 }

Good stuff, it's good to connect knowledge across dev languages, it think. — Dan Rosenstark
– Dan Rosenstark, Commented Mar 14, 2010 at 11:45
Which part of the accepted answer are you interested in? The part where a class "offers" different iterators or the part where two iterators of the same object are used simultaneously? Or both? ;-) — VolkerK
– VolkerK, Commented Mar 14, 2010 at 12:18
You might want to explain what yield return does or give an example usecase — Gordon
– Gordon, Commented Mar 14, 2010 at 13:21

user187291 · Accepted Answer · 2010-03-14 13:26:58Z

Yes, you can.

foreach(new IteratorOne($obj) as $foo) ....

foreach(new IteratorTwo($obj) as $bar) .....

Actually, as long as you class implements Iterator, you can apply any arbitrary IteratorIterator to it. This is a Good Thing, because applied meta iterators are not required to know anything about the class in question.

Consider, for example, an iterable class like this

class JustList implements Iterator
{
    function __construct() { $this->items = func_get_args(); }
    function rewind()      { return reset($this->items); }
    function current()     { return current($this->items); }
    function key()         { return key($this->items); }
    function next()        { return next($this->items); }
    function valid()       { return key($this->items) !== null; }
}

Let's define some meta iterators

class OddIterator extends FilterIterator {
    function accept() { return parent::current() % 2;  }
}

class EvenIterator extends FilterIterator {
    function accept() { return parent::current() % 2 == 0;  }
}

Now apply meta iterators to the base class:

 $list = new JustList(1, 2, 3, 4, 5, 6, 7, 8, 9);

 foreach(new OddIterator($list) as $p) echo $p;  // prints 13579
 foreach(new EvenIterator($list) as $p) echo $p; // prints 2468

UPDATE: php has no inner classes, so you're kinda out of luck here, without resorting to eval, at least. Your iterators need to be separate classes, which are aware of the baseclass structure. You can make it less harmful by providing methods in the base class that instantiate iterators behind the scenes:

 class TreeDepthFirstIterator implements Iterator 
 {
      function __construct($someTree).....
 }


 class Tree
 {
       function depthFirst() { return new TreeDepthFirstIterator($this); }
        ....
 }


 foreach($myTree->depthFirst() as $node).....

Another option is to use lambdas instead of foreach. This is nicer and more flexible, requires php5.3 though:

 class Tree
 {
        function depthFirst($func) {
              while($node = .....)
                $func($node);

 .....

 $myTree->depthFirst(function($node) {
     echo $node->name;
 });

Thank you for explanation, but if I need to iterate over more complex structure (for example tree) I need to change iteration algorighm, not only filter some elements. Please see edits to original message...

VolkerK · Accepted Answer · 2010-03-14 13:30:58Z

1

For your purpose it might be sufficient to have a "mode" flag in your class, so the user can choose whether to have a bread-first or a depth-first iterator.

class Tree {
  const TREE_DEPTH_FIRST = 0;
  const TREE_BREADTH_FIRST = 0;

  protected $mode;
  protected $current;

  public function __construct($mode=Tree::TREE_DEPTH_FIRST) {
    $this->mode = $mode;
  }

  public function setMode($mode) {
    ...
  }

  public function next() {
    $this->current = advance($this->current, $this->mode);
  }  
  ....
}

(and the short answer to your initial question: no php doesn't have the syntactic sugar of yield return and it doesn't have inner private classes, i.e. whatever you would need the iterator you're returning to do with the "original" object has to be exposed to the outside world. So you'd probably end up "preparing" all elements for an iterator object like ArrayIterator, the very thing you avoid by using yield)

edited Mar 14, 2010 at 13:30

answered Mar 14, 2010 at 13:25

VolkerK

96.3k20 gold badges169 silver badges232 bronze badges

1 Comment

artvolk Over a year ago

Sorry, it seems I can't mark two posts as accepted answer, so I note in my message that your message is what I looking for too.

user187291 · Accepted Answer · 2011-10-07 01:37:00Z

1

This code shows you how to add multiple iterators in a class.

class TreeNode {

public function getOddIterator () {
  return new OddIterator($this->nodes);
}

public function getEvenIterator () {
  return new EvenIterator($this->nodes);
}

}

edited Oct 7, 2011 at 1:37

user187291

54.1k19 gold badges98 silver badges127 bronze badges

answered Mar 14, 2010 at 13:18

Darkerstar

9321 gold badge8 silver badges17 bronze badges

Comments

Bill · Accepted Answer · 2014-07-31 01:17:27Z

0

You can have multiple Iterators. The key idea in the Iterator is to take the responsibility for access and traversal out of the list object and put it into an iterator object. So if you want to have multiple Iterators with the same list or different lists; there's no problem.

You can find four different PHP examples here:

http://www.php5dp.com/category/design-patterns/iterator/

You can also use them with Linked Lists.

Cheers, Bill

answered Jul 31, 2014 at 1:17

Bill

953 bronze badges

Collectives™ on Stack Overflow

Are Multiple Iterators possible in php?

4 Answers 4

1 Comment

1 Comment

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

1 Comment

1 Comment

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related