JDatabaseIterator

class JDatabaseIterator implements Countable, Iterator

Joomla Platform Database Driver Class

Methods

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

Database iterator constructor.

__destruct()

Database iterator destructor.

object
current()

The current element in the iterator.

int|string
key()

The key of the current element in the iterator.

void
next()

Moves forward to the next result from the SQL query.

void
rewind()

Rewinds the iterator.

boolean
valid()

Checks if the current position of the iterator is valid.

Details

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

Database iterator constructor.

Parameters

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.

Exceptions

InvalidArgumentException

__destruct()

Database iterator destructor.

object current()

The current element in the iterator.

Return Value

object

See also

Iterator::current()

int|string key()

The key of the current element in the iterator.

Return Value

int|string

See also

Iterator::key()

void next()

Moves forward to the next result from the SQL query.

Return Value

void

See also

Iterator::next()

void rewind()

Rewinds the iterator.

This iterator cannot be rewound.

Return Value

void

See also

Iterator::rewind()

boolean valid()

Checks if the current position of the iterator is valid.

Return Value

boolean

See also

Iterator::valid()