< SearchIterator > Protocol Reference
[Example classes]

Iterator to search for a specific element. More...

List of all members.

Public Member Functions
	__call ($func, $params)
	next ()
	rewind ()
	valid ()
Private Attributes
	$done = false

---

Detailed Description

Iterator to search for a specific element.

Author:

Marcus Boerger

Version:

1.0

This extended FilterIterator stops after finding the first acceptable value.

Definition at line 20 of file searchiterator.inc.

---

Member Function Documentation

SearchIterator-p::__call	(	$	func,
		$	params
	)

Aggregates the inner iterator.

Definition at line 52 of file searchiterator.inc.

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

SearchIterator-p::next

(

)

Do not move forward but instead mark as finished.

Returns:

void

Definition at line 45 of file searchiterator.inc.

    {
        $this->done = true;
    }

SearchIterator-p::rewind

(

)

Rewind and reset so that it once again searches.

Returns:

void

Definition at line 28 of file searchiterator.inc.

    {
        parent::rewind();
        $this->done = false;
    }

SearchIterator-p::valid

(

)

Returns:

whether the current element is valid which can only happen once per iteration.

Definition at line 37 of file searchiterator.inc.

    {
        return !$this->done && parent::valid();
    }

---

Member Data Documentation

SearchIterator-p::$done = false [private]

For internal use only.

whether an entry was found already

Definition at line 23 of file searchiterator.inc.

---

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

• searchiterator.inc

---