ItemIterator Class Reference
[Db]
Generic iterator class; needs to be overloaded by subclasses providing specific implementations.
More...
Public Member Functions | |
| eof () | |
| & | next () |
| & | nextWithKey () |
| wasEmpty () | |
Detailed Description
Generic iterator class; needs to be overloaded by subclasses providing specific implementations.Definition at line 19 of file ItemIterator.inc.php.
Member Function Documentation
| ItemIterator.eof | ( | ) |
Return a boolean indicating whether or not we've reached the end of results
- Returns:
- boolean
Reimplemented in ArrayItemIterator, VirtualArrayIterator, DAOResultFactory, and DBRowIterator.
Definition at line 61 of file ItemIterator.inc.php.
| & ItemIterator.next | ( | ) |
Return the next item in the iterator.
- Returns:
- object
Reimplemented in ArrayItemIterator, VirtualArrayIterator, DAOResultFactory, DBRowIterator, and JournalReportIterator.
Definition at line 24 of file ItemIterator.inc.php.
| & ItemIterator.nextWithKey | ( | ) |
Return the next item with key.
- Returns:
- array ($key, $value);
Reimplemented in ArrayItemIterator, VirtualArrayIterator, DAOResultFactory, DBRowIterator, and JournalReportIterator.
Definition at line 33 of file ItemIterator.inc.php.
| ItemIterator.wasEmpty | ( | ) |
Return a boolean indicating whether or not this iterator was empty from the beginning
- Returns:
- boolean
Reimplemented in ArrayItemIterator, VirtualArrayIterator, DAOResultFactory, and DBRowIterator.
Definition at line 69 of file ItemIterator.inc.php.
The documentation for this class was generated from the following file:
- classes/core/ItemIterator.inc.php
