PaginatorIterator Class Reference

Class allowing for the continuous iteration of a Zend instance. More...

Public Member Functions
	__construct (Paginator $paginator)
	current ()
	Return the current element http://php.net/manual/en/iterator.current.php.
	next ()
	Move forward to next element http://php.net/manual/en/iterator.next.php.
	key ()
	Return the key of the current element http://php.net/manual/en/iterator.key.php.
	valid ()
	Checks if current position is valid http://php.net/manual/en/iterator.valid.php.
	rewind ()
	Rewind the Iterator to the first element http://php.net/manual/en/iterator.rewind.php.
	getInnerIterator ()
	Returns the inner iterator for the current entry.

Protected Attributes
	$paginator
	Internal Paginator for iteration.
	$valid = true
	Value for valid method.

Detailed Description

Class allowing for the continuous iteration of a Zend instance.

Useful for representing remote paginated data sources as a single Iterator

Constructor & Destructor Documentation

__construct

(

Paginator

$paginator

)

Member Function Documentation

current

(

)

Return the current element http://php.net/manual/en/iterator.current.php.

Returns

mixed Can return any type.

getInnerIterator

(

)

Returns the inner iterator for the current entry.

The inner iterator for the current entry.

key

(

)

Return the key of the current element http://php.net/manual/en/iterator.key.php.

Returns

mixed scalar on success, or null on failure.

next

(

)

Move forward to next element http://php.net/manual/en/iterator.next.php.

Returns

void Any returned value is ignored.

rewind

(

)

Rewind the Iterator to the first element http://php.net/manual/en/iterator.rewind.php.

Returns

void Any returned value is ignored.

valid

(

)

Checks if current position is valid http://php.net/manual/en/iterator.valid.php.

Returns

boolean The return value will be casted to boolean and then evaluated. Returns true on success or false on failure.

Member Data Documentation

Paginator $paginator

protected

Internal Paginator for iteration.

bool $valid = true

protected

Value for valid method.