Public Member Functions | |
| __construct ($resultFactory) | |
| count () | |
| current () | |
| key () | |
| next () | |
| rewind () | |
| valid () | |
Data Fields | |
| $_current = null | |
| $_i = 0 | |
| $_resultFactory | |
Detailed Description
Wrapper around a DAOResultFactory providing a proper PHP Iterator implementation.
Definition at line 17 of file DAOResultIterator.inc.php.
Constructor & Destructor Documentation
◆ __construct()
| DAOResultIterator::__construct | ( | $resultFactory | ) |
Create an Iterator for the specified DAOResultFactory.
- Parameters
-
$itemIterator ItemIterator
Definition at line 40 of file DAOResultIterator.inc.php.
Member Function Documentation
◆ count()
| DAOResultIterator::count | ( | ) |
Definition at line 91 of file DAOResultIterator.inc.php.
◆ current()
| DAOResultIterator::current | ( | ) |
Definition at line 48 of file DAOResultIterator.inc.php.
References $_current.
◆ key()
| DAOResultIterator::key | ( | ) |
Return the 0-based index for the current object. Note that this is NOT the DataObject's ID – for that, call getId() on the current element.
- Returns
- int|null
Definition at line 58 of file DAOResultIterator.inc.php.
References $_i.
◆ next()
| DAOResultIterator::next | ( | ) |
Definition at line 67 of file DAOResultIterator.inc.php.
◆ rewind()
| DAOResultIterator::rewind | ( | ) |
Rewind the DAOResultFactory to the begining. WARNING that this operation is not arbitrarily supported – it can only be called before the first call to next().
Definition at line 77 of file DAOResultIterator.inc.php.
◆ valid()
| DAOResultIterator::valid | ( | ) |
Definition at line 84 of file DAOResultIterator.inc.php.
Field Documentation
◆ $_current
| DataObject DAOResultIterator::$_current = null |
Current return value data object.
Definition at line 28 of file DAOResultIterator.inc.php.
Referenced by current().
◆ $_i
| $_i DAOResultIterator::$_i = 0 |
int 0-based index of current data object.
Definition at line 34 of file DAOResultIterator.inc.php.
Referenced by key().
◆ $_resultFactory
| DAOResultFactory DAOResultIterator::$_resultFactory |
Definition at line 22 of file DAOResultIterator.inc.php.
The documentation for this class was generated from the following file:
