Collection_Iterator Class Reference

Data read from array. More...

Inheritance diagram for Collection_Iterator:

Public Member Functions
	__construct (Iterator $iterator, array $options=array())
	count ()
	current ()
	next ()
	Moves to the next position.
	currentPosition ()
	Returns current position in the set.
	valid ()
	Returns item at current position, staying at the current position.
	seek ($pos)
	getInnerIterator ()
	isBidirectional ()
	Returns true if data can be traversed in both directions.
	key ()
	Returns current position in the set.
	offsetExists ($offset)
	offsetGet ($offset)
	offsetSet ($offset, $value)
	offsetUnset ($offset)
	rewind ()
	Rewinds to the beginning.
	close ()
	Closes the collection and frees up resources.
	prefetch ($limit=false, $start=false)
	Items will be prefetched (if needed) in a batch for later retrieval.
Protected Attributes
	$iterator

---

Detailed Description

Data read from array.

---

Constructor & Destructor Documentation

Collection_Iterator::__construct	(	Iterator $	iterator,
		array $	options = array()
	)

---

Member Function Documentation

Collection_Iterator::close

(

)

Closes the collection and frees up resources.

Reimplemented from Collection.

Collection_Iterator::count

(

)

Collection_Iterator::current

(

)

Collection_Iterator::currentPosition

(

)

Returns current position in the set.

Reimplemented from Collection.

Collection_Iterator::getInnerIterator

(

)

Returns:

Iterator

Collection_Iterator::isBidirectional

(

)

Returns true if data can be traversed in both directions.

Returns:

boolean

Reimplemented from Collection.

Collection_Iterator::key

(

)

Returns current position in the set.

Reimplemented from Collection.

Collection_Iterator::next

(

)

Moves to the next position.

Reimplemented from Collection.

Collection_Iterator::offsetExists

(

$

offset

)

Returns:

boolean

Reimplemented from Collection.

Collection_Iterator::offsetGet

(

$

offset

)

Returns:

mixed

Reimplemented from Collection.

Collection_Iterator::offsetSet	(	$	offset,
		$	value
	)

Reimplemented from Collection.

Collection_Iterator::offsetUnset

(

$

offset

)

Reimplemented from Collection.

Collection_Iterator::prefetch	(	$	limit = false,
		$	start = false
	)

Items will be prefetched (if needed) in a batch for later retrieval.

Parameters:

Number	of items to prefetch or false
Start	of the prefetch or false for current position

Returns:

boolean TRUE if prefetch was successfull, FALSE if prefetch can't be supported

Reimplemented from Collection.

Collection_Iterator::rewind

(

)

Rewinds to the beginning.

Reimplemented from Collection.

Collection_Iterator::seek

(

$

pos

)

Collection_Iterator::valid

(

)

Returns item at current position, staying at the current position.

Returns true if there is data at current possition

Returns:

boolean

Reimplemented from Collection.

---

Field Documentation

Collection_Iterator::$iterator [protected]

---

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

• include/core/Collection/Iterator.php