JDatabaseIterator

Implements \Countable, \Iterator

Joomla Platform Database Driver Class

abstract
since

12.1

package

Joomla.Platform

Methods

__construct

Database iterator constructor.

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

\InvalidArgumentException

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

12.1

current

The current element in the iterator.

current() : object
see \Iterator::current()
since

12.1

Response

object

fetchObject

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

fetchObject() : mixed
abstract
since

12.1

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
abstract
since

12.1

key

The key of the current element in the iterator.

key() : integer|string
see \Iterator::key()
since

12.1

Response

integer|string

next

Moves forward to the next result from the SQL query.

next() : void
see \Iterator::next()
since

12.1

rewind

Rewinds the iterator.

rewind() : void

This iterator cannot be rewound.

see \Iterator::rewind()
since

12.1

valid

Checks if the current position of the iterator is valid.

valid() : boolean
see \Iterator::valid()
since

12.1

Response

boolean

Properties

cursor

The database cursor.

Type(s)

mixed

class

The class of object to create.

Type(s)

string

_column

The name of the column to use for the key of the database record.

Type(s)

mixed

_current

The current database record.

Type(s)

mixed

_key

A numeric or string key for the current database record.

Type(s)

integer|string

_fetched

The number of fetched records.

Type(s)

integer