Open Journal Systems
3.3.0
|
Public Member Functions | |
__construct ($records, $idFields=array()) | |
atFirstPage () | |
atLastPage () | |
close () | |
eof () | |
getCount () | |
getPage () | |
getPageCount () | |
next () | |
nextWithKey () | |
toArray () | |
wasEmpty () | |
Public Member Functions inherited from ItemIterator | |
__construct () | |
Data Fields | |
$count | |
$idFields | |
$isFirst | |
$isLast | |
$page | |
$pageCount | |
$records | |
$wasEmpty | |
Wrapper around ADORecordSet providing "factory" features for generating objects from DAOs.
Definition at line 20 of file DBRowIterator.inc.php.
DBRowIterator::__construct | ( | $records, | |
$idFields = array() |
|||
) |
Constructor. Initialize the DBRowIterator
$records | object ADO record set |
$dao | object DAO class for factory |
$functionName | The function to call on $dao to create an object |
Definition at line 49 of file DBRowIterator.inc.php.
References $idFields, $records, and wasEmpty().
DBRowIterator::atFirstPage | ( | ) |
Determine whether this iterator represents the first page of a set.
Reimplemented from ItemIterator.
Definition at line 115 of file DBRowIterator.inc.php.
References $isFirst.
DBRowIterator::atLastPage | ( | ) |
Determine whether this iterator represents the last page of a set.
Reimplemented from ItemIterator.
Definition at line 123 of file DBRowIterator.inc.php.
References $isLast.
DBRowIterator::close | ( | ) |
Clean up the record set. This is called aggressively because it can free resources.
Definition at line 176 of file DBRowIterator.inc.php.
DBRowIterator::eof | ( | ) |
Return a boolean indicating whether or not we've reached the end of results
Reimplemented from ItemIterator.
Definition at line 155 of file DBRowIterator.inc.php.
References close().
Referenced by toArray().
DBRowIterator::getCount | ( | ) |
Get the total number of items in the set.
Reimplemented from ItemIterator.
Definition at line 139 of file DBRowIterator.inc.php.
References $count.
DBRowIterator::getPage | ( | ) |
Get the page number of a set that this iterator represents.
Reimplemented from ItemIterator.
Definition at line 131 of file DBRowIterator.inc.php.
References $page.
DBRowIterator::getPageCount | ( | ) |
Get the total number of pages in the set.
Reimplemented from ItemIterator.
Definition at line 147 of file DBRowIterator.inc.php.
References $pageCount.
DBRowIterator::next | ( | ) |
Return the object representing the next row.
Reimplemented from ItemIterator.
Definition at line 78 of file DBRowIterator.inc.php.
References $records, and close().
Referenced by nextWithKey(), and toArray().
DBRowIterator::nextWithKey | ( | ) |
Return the next row, with key.
Reimplemented from ItemIterator.
Definition at line 95 of file DBRowIterator.inc.php.
References next().
DBRowIterator::toArray | ( | ) |
Convert this iterator to an array.
Reimplemented from ItemIterator.
Definition at line 186 of file DBRowIterator.inc.php.
DBRowIterator::wasEmpty | ( | ) |
Return a boolean indicating whether or not this resultset was empty from the beginning
Reimplemented from ItemIterator.
Definition at line 168 of file DBRowIterator.inc.php.
References $wasEmpty.
Referenced by __construct().
DBRowIterator::$count |
Definition at line 39 of file DBRowIterator.inc.php.
Referenced by getCount().
array DBRowIterator::$idFields |
an array of primary key field names that uniquely identify a result row in the records array.
Definition at line 31 of file DBRowIterator.inc.php.
Referenced by __construct().
DBRowIterator::$isFirst |
Definition at line 36 of file DBRowIterator.inc.php.
Referenced by atFirstPage().
DBRowIterator::$isLast |
Definition at line 37 of file DBRowIterator.inc.php.
Referenced by atLastPage().
DBRowIterator::$page |
Definition at line 38 of file DBRowIterator.inc.php.
Referenced by getPage().
DBRowIterator::$pageCount |
Definition at line 40 of file DBRowIterator.inc.php.
Referenced by getPageCount().
DBRowIterator::$records |
The ADORecordSet to be wrapped around
Definition at line 22 of file DBRowIterator.inc.php.
Referenced by __construct(), and next().
DBRowIterator::$wasEmpty |
True iff the resultset was always empty
Definition at line 34 of file DBRowIterator.inc.php.
Referenced by wasEmpty().