IteratorIterator Class Reference

Inheritance diagram for IteratorIterator:

Collaboration diagram for IteratorIterator:

Public Member Functions
	__call ($func, $params)
	__construct (Traversable $iterator, $classname=null)
	current ()
	getInnerIterator ()
	key ()
	next ()
	rewind ()
	valid ()

Private Attributes
	$iterator

Detailed Description

Basic Iterator wrapper.

Since

PHP 5.1

This iterator wrapper allows to convert anything that is traversable into an Iterator. It is very important to understand that most classes that do not implement Iterator have their reasone to. Most likely they do not allow the full Iterator feature set. If so you need to provide techniques to prevent missuse. If you do not you must expect exceptions or fatal errors.

It is also possible to derive the class and implement IteratorAggregate by downcasting the instances returned in getIterator. See the following example (assuming BaseClass implements Traversable):

class SomeClass extends BaseClass implements IteratorAggregate
{
  function getIterator()
  {
    return new IteratorIterator($this, 'BaseClass');
  }
}

As you can see in the example this approach requires that the class to downcast to is actually a base class of the specified iterator to wrap. Omitting the downcast in the above example would result in an endless loop since IteratorIterator::__construct() would call SomeClass::getIterator().

Definition at line 40 of file iteratoriterator.inc.

Constructor & Destructor Documentation

IteratorIterator::__construct	(	Traversable	$iterator,
			$classname = null
	)

Construct an IteratorIterator from an Iterator or an IteratorAggregate.

Parameters

iterator	inner iterator
classname	optional class the iterator has to be downcasted to

Definition at line 47 of file iteratoriterator.inc.

References $iterator.

    {
        if ($iterator instanceof IteratorAggregate)
        {
            $iterator = $iterator->getIterator();
        }
        if ($iterator instanceof Iterator)
        {
            $this->iterator = $iterator;
        }
        else
        {
            throw new Exception("Classes that only implement Traversable can be wrapped only after converting class IteratorIterator into c code");
        }
    }

Member Function Documentation

IteratorIterator::__call	(		$func,
			$params
	)

Aggregate the inner iterator.

Parameters

func	Name of method to invoke
params	Array of parameters to pass to method

Definition at line 110 of file iteratoriterator.inc.

    {
        return call_user_func_array(array($this->iterator, $func), $params);
    }

IteratorIterator::current

(

)

Returns

current value

Implements Iterator.

Definition at line 86 of file iteratoriterator.inc.

    {
        return $this->iterator->current();
    }

IteratorIterator::getInnerIterator

(

)

Returns

the inner iterator as passed to the constructor

Implements OuterIterator.

Definition at line 65 of file iteratoriterator.inc.

References $iterator.

Referenced by InfiniteIterator\next().

    {
        return $this->iterator;
    }

IteratorIterator::key

(

)

Returns

current key

Implements Iterator.

Definition at line 79 of file iteratoriterator.inc.

    {
        return $this->iterator->key();
    }

IteratorIterator::next

(

)

forward to next element

Implements Iterator.

Definition at line 93 of file iteratoriterator.inc.

    {
        return $this->iterator->next();
    }

IteratorIterator::rewind

(

)

rewind to the first element

Implements Iterator.

Definition at line 100 of file iteratoriterator.inc.

    {
        return $this->iterator->rewind();
    }

IteratorIterator::valid

(

)

Returns

whether the iterator is valid

Implements Iterator.

Definition at line 72 of file iteratoriterator.inc.

Referenced by InfiniteIterator\next().

    {
        return $this->iterator->valid();
    }

Member Data Documentation

IteratorIterator::$iterator

private

The inner iterator must be private because when this class will be converted to c code it won't no longer be available.

Definition at line 118 of file iteratoriterator.inc.

Referenced by __construct(), and getInnerIterator().

---

The documentation for this class was generated from the following file:

• iteratoriterator.inc