Docs For Class JDatabaseIterator

Description

Implements interfaces:

Countable (internal interface)
Iterator (internal interface)

Joomla Platform Database Driver Class

abstract:
since: 12.1

Located in /libraries/joomla/database/iterator.php (line 19)

Direct descendents

Class	Description
JDatabaseIteratorMysql	MySQL database iterator.
JDatabaseIteratorMysqli	MySQLi database iterator.
JDatabaseIteratorPdo	PDO database iterator.
JDatabaseIteratorPostgresql	PostgreSQL database iterator.
JDatabaseIteratorSqlsrv	SQL server database iterator.

Variable Summary

string $class

mixed $cursor

Method Summary

JDatabaseIterator __construct (mixed $cursor, [string $column = null], [string $class = 'stdClass'])

void __destruct ()

object current ()

mixed fetchObject ()

void freeResult ()

scalar key ()

void next ()

void rewind ()

boolean valid ()

Variables

string $class (line 35)

The class of object to create.

since: 12.1
access: protected

mixed $cursor (line 27)

The database cursor.

since: 12.1
access: protected

Methods

Constructor __construct (line 78)

Database iterator constructor.

throws: InvalidArgumentException
access: public

JDatabaseIterator __construct (mixed $cursor, [string $column = null], [string $class = 'stdClass'])

mixed $cursor: The database cursor.
string $column: An option column to use as the iterator key.
string $class: The class of object that is returned.

Destructor __destruct (line 97)

Database iterator destructor.

since: 12.1
access: public

void __destruct ()

current (line 113)

The current element in the iterator.

see: Iterator::current()
since: 12.1
access: public

object current ()

Implementation of:

Iterator::current

fetchObject (line 195)

Method to fetch a row from the result set cursor as an object.

return: Either the next row from the result set or false if there are no more rows.
abstract:
since: 12.1
access: protected

mixed fetchObject ()

Redefined in descendants as:

JDatabaseIteratorMysql::fetchObject() : Method to fetch a row from the result set cursor as an object.
JDatabaseIteratorMysqli::fetchObject() : Method to fetch a row from the result set cursor as an object.
JDatabaseIteratorPdo::fetchObject() : Method to fetch a row from the result set cursor as an object.
JDatabaseIteratorPostgresql::fetchObject() : Method to fetch a row from the result set cursor as an object.
JDatabaseIteratorSqlsrv::fetchObject() : Method to fetch a row from the result set cursor as an object.

freeResult (line 204)

Method to free up the memory used for the result set.

abstract:
since: 12.1
access: protected

void freeResult ()

Redefined in descendants as:

JDatabaseIteratorMysql::freeResult() : Method to free up the memory used for the result set.
JDatabaseIteratorMysqli::freeResult() : Method to free up the memory used for the result set.
JDatabaseIteratorPdo::freeResult() : Method to free up the memory used for the result set.
JDatabaseIteratorPostgresql::freeResult() : Method to free up the memory used for the result set.
JDatabaseIteratorSqlsrv::freeResult() : Method to free up the memory used for the result set.

key (line 126)

The key of the current element in the iterator.

see: Iterator::key()
since: 12.1
access: public

scalar key ()

Implementation of:

Iterator::key

next (line 139)

Moves forward to the next result from the SQL query.

see: Iterator::next()
since: 12.1
access: public

void next ()

Implementation of:

Iterator::next

rewind (line 171)

Rewinds the iterator.

This iterator cannot be rewound.

see: Iterator::rewind()
since: 12.1
access: public

void rewind ()

Implementation of:

Iterator::rewind

valid (line 183)

Checks if the current position of the iterator is valid.

see: Iterator::valid()
since: 12.1
access: public

boolean valid ()

Implementation of:

Iterator::valid