KjwResultSet Class Reference
[Database (SQL) handling]
KjwResultSet is an abstraction of SQL database result sets.
More...
Public Member Functions | |
| KjwResultSet () | |
| Construct a KjwResultSet. | |
| destroy () | |
| Destructor performing cleanup. | |
| getNext () | |
| Fetch the current result row and advance pointer to the next. | |
| at () | |
| Returns at which row the resultset is. | |
| size () | |
| Returns the number of results in the result set as an integer. | |
| seekAbs ($offset) | |
| Seek in the resultset to an absolute position. | |
| seekRel ($offset) | |
| Seek in the resultset to a relative position. | |
| getRandom ($max=-1) | |
| Get a new resultset with at most $max elements shuffled from the entire set. | |
Detailed Description
KjwResultSet is an abstraction of SQL database result sets.Every database make needs an implementation of this abstract class.
Definition at line 27 of file KjwResultSet.php.
Member Function Documentation
| KjwResultSet::at | ( | ) |
Returns at which row the resultset is.
- Returns:
- The current zero-based position.
Reimplemented in KjwArrayResultSet, KjwMsResultSet, KjwMyResultSet, and KjwPgResultSet.
Definition at line 54 of file KjwResultSet.php.
References KjwObject::notImplemented().
Referenced by getRandom(), and seekRel().
| KjwResultSet::destroy | ( | ) |
Destructor performing cleanup.
Don't rely on this being called ever. The user must call it by hand.
Reimplemented from KjwObject.
Reimplemented in KjwArrayResultSet, KjwMsResultSet, KjwMyResultSet, and KjwPgResultSet.
Definition at line 36 of file KjwResultSet.php.
| KjwResultSet::getNext | ( | ) |
Fetch the current result row and advance pointer to the next.
- Returns:
- An associative array or false if beyond the last element.
Reimplemented in KjwArrayResultSet, KjwMsResultSet, KjwMyResultSet, and KjwPgResultSet.
Definition at line 45 of file KjwResultSet.php.
References KjwObject::notImplemented().
Referenced by getRandom().
| KjwResultSet::getRandom | ( | $ | max = -1 |
) |
Get a new resultset with at most $max elements shuffled from the entire set.
Shuffles an array of integer first and then seeks through the result set.
- Parameters:
-
$max Get at most max elements or all if max is -1.
- Returns:
- A new shuffled resultset.
Definition at line 94 of file KjwResultSet.php.
| KjwResultSet::seekAbs | ( | $ | offset | ) |
Seek in the resultset to an absolute position.
- Parameters:
-
$offset The zero-based offset.
- Returns:
- A boolean specifying success.
Reimplemented in KjwArrayResultSet, KjwMsResultSet, KjwMyResultSet, and KjwPgResultSet.
Definition at line 73 of file KjwResultSet.php.
References KjwObject::notImplemented().
Referenced by getRandom(), and seekRel().
| KjwResultSet::seekRel | ( | $ | offset | ) |
Seek in the resultset to a relative position.
- Parameters:
-
$offset A relative offset.
- Returns:
- A boolean specifying success.
Definition at line 83 of file KjwResultSet.php.
| KjwResultSet::size | ( | ) |
Returns the number of results in the result set as an integer.
- Returns:
- The number of results in this resultset.
Reimplemented in KjwArrayResultSet, KjwMsResultSet, KjwMyResultSet, and KjwPgResultSet.
Definition at line 63 of file KjwResultSet.php.
References KjwObject::notImplemented().
Referenced by getRandom().
The documentation for this class was generated from the following file:
