Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
ItemIterator Class Reference
Inheritance diagram for ItemIterator:
ArrayItemIterator DAOResultFactory DBRowIterator VirtualArrayIterator

Public Member Functions

 atFirstPage ()
 
 atLastPage ()
 
 eof ()
 
 getCount ()
 
 getPage ()
 
 getPageCount ()
 
next ()
 
nextWithKey ()
 
toArray ()
 
 wasEmpty ()
 

Detailed Description

Generic iterator class; needs to be overloaded by subclasses providing specific implementations.

Definition at line 18 of file ItemIterator.inc.php.

Member Function Documentation

ItemIterator::atFirstPage ( )

Determine whether this iterator represents the first page of a set.

Returns
boolean

Definition at line 40 of file ItemIterator.inc.php.

ItemIterator::atLastPage ( )

Determine whether this iterator represents the last page of a set.

Returns
boolean

Definition at line 48 of file ItemIterator.inc.php.

ItemIterator::eof ( )

Return a boolean indicating whether or not we've reached the end of results

Returns
boolean

Definition at line 80 of file ItemIterator.inc.php.

ItemIterator::getCount ( )

Get the total number of items in the set.

Returns
int

Definition at line 64 of file ItemIterator.inc.php.

ItemIterator::getPage ( )

Get the page number of a set that this iterator represents.

Returns
int

Definition at line 56 of file ItemIterator.inc.php.

ItemIterator::getPageCount ( )

Get the total number of pages in the set.

Returns
int

Definition at line 72 of file ItemIterator.inc.php.

& ItemIterator::next ( )

Return the next item in the iterator.

Returns
object

Definition at line 23 of file ItemIterator.inc.php.

& ItemIterator::nextWithKey ( )

Return the next item with key.

Returns
array ($key, $value);

Definition at line 32 of file ItemIterator.inc.php.

& ItemIterator::toArray ( )

Convert this iterator to an array.

Returns
array

Definition at line 96 of file ItemIterator.inc.php.

ItemIterator::wasEmpty ( )

Return a boolean indicating whether or not this iterator was empty from the beginning

Returns
boolean

Definition at line 88 of file ItemIterator.inc.php.


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