DatabaseIterator
Implements \Countable, \IteratorJoomla Framework Database Driver Class
| since |
1.0 |
|---|
Methods
__construct
Database iterator constructor.
__construct(mixed $cursor, string $column = null, string $class = '\\stdClass')
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- $cursor
mixedThe database cursor.- $column
stringAn option column to use as the iterator key.- $class
stringThe class of object that is returned.
__destruct
Database iterator destructor.
__destruct()
| since |
1.0 |
|---|
count
Get the number of rows in the result set for the executed SQL given by the cursor.
count() : integer
| see | \Joomla\Database\Countable::count() |
|---|---|
| since |
1.0 |
Response
integerThe number of rows in the result set.
current
The current element in the iterator.
current() : object
| see | \Joomla\Database\Iterator::current() |
|---|---|
| since |
1.0 |
Response
object
fetchObject
Method to fetch a row from the result set cursor as an object.
fetchObject() : mixed
| since |
1.0 |
|---|
Response
mixedEither the next row from the result set or false if there are no more rows.
freeResult
Method to free up the memory used for the result set.
freeResult() : void
| since |
1.0 |
|---|
key
The key of the current element in the iterator.
key() : scalar
| see | \Joomla\Database\Iterator::key() |
|---|---|
| since |
1.0 |
Response
scalar
next
Moves forward to the next result from the SQL query.
next() : void
| see | \Joomla\Database\Iterator::next() |
|---|---|
| since |
1.0 |
rewind
Rewinds the iterator.
rewind() : void
This iterator cannot be rewound.
| see | \Joomla\Database\Iterator::rewind() |
|---|---|
| since |
1.0 |
valid
Checks if the current position of the iterator is valid.
valid() : boolean
| see | \Joomla\Database\Iterator::valid() |
|---|---|
| since |
1.0 |
Response
boolean
Properties
cursor
The database cursor.
| since |
1.0 |
|---|
Type(s)
mixed
class
The class of object to create.
| since |
1.0 |
|---|
Type(s)
string
column
The name of the column to use for the key of the database record.
| since |
1.0 |
|---|
Type(s)
mixed
current
The current database record.
| since |
1.0 |
|---|
Type(s)
mixed
key
A numeric or string key for the current database record.
| since |
1.0 |
|---|
Type(s)
scalar
fetched
The number of fetched records.
| since |
1.0 |
|---|
Type(s)
integer