Class JDatabaseIterator

Joomla Platform Database Driver Class

JDatabaseIterator implements Countable, Iterator

Direct known subclasses

JDatabaseIteratorMysql, JDatabaseIteratorMysqli, JDatabaseIteratorPdo, JDatabaseIteratorPostgresql, JDatabaseIteratorSqlsrv

Indirect known subclasses

JDatabaseIteratorOracle, JDatabaseIteratorPdomysql, JDatabaseIteratorSqlazure, JDatabaseIteratorSqlite

Abstract
Package: Joomla\Platform\Database
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 12.1
Located at joomla/database/iterator.php

Methods summary

`public`	# `__construct( mixed $cursor, string $column = null, string $class = 'stdClass' )` Database iterator constructor. Database iterator constructor. Parameters `$cursor` `mixed` - $cursor The database cursor. `$column` `string` - $column An option column to use as the iterator key. `$class` `string` - $class The class of object that is returned. Throws `InvalidArgumentException`
`public`	# `__destruct( )` Database iterator destructor. Database iterator destructor. Since 12.1
`public object`	# `current( )` The current element in the iterator. The current element in the iterator. Returns `object` Since 12.1 See `Iterator::current()` Implementation of `Iterator::current()`
`public scalar`	# `key( )` The key of the current element in the iterator. The key of the current element in the iterator. Returns `scalar` Since 12.1 See `Iterator::key()` Implementation of `Iterator::key()`
`public`	# `next( )` Moves forward to the next result from the SQL query. Moves forward to the next result from the SQL query. Since 12.1 See `Iterator::next()` Implementation of `Iterator::next()`
`public`	# `rewind( )` Rewinds the iterator. Rewinds the iterator. This iterator cannot be rewound. Since 12.1 See `Iterator::rewind()` Implementation of `Iterator::rewind()`
`public boolean`	# `valid( )` Checks if the current position of the iterator is valid. Checks if the current position of the iterator is valid. Returns `boolean` Since 12.1 See `Iterator::valid()` Implementation of `Iterator::valid()`
`abstract protected mixed`	# `fetchObject( )` Method to fetch a row from the result set cursor as an object. Method to fetch a row from the result set cursor as an object. Returns `mixed` - Either the next row from the result set or false if there are no more rows. Since 12.1
`abstract protected`	# `freeResult( )` Method to free up the memory used for the result set. Method to free up the memory used for the result set. Since 12.1

Methods inherited from Countable

count()

Magic methods summary

Properties summary

`protected mixed`	`$cursor`	# The database cursor. The database cursor. Since 12.1
`protected string`	`$class`	# The class of object to create. The class of object to create. Since 12.1

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JDatabaseIterator

Direct known subclasses

Indirect known subclasses

Methods summary

Parameters

Throws

Since

Returns

Since

See

Implementation of

Returns

Since

See

Implementation of

Since

See

Implementation of

Since

See

Implementation of

Returns

Since

See

Implementation of

Returns

Since

Since

Methods inherited from Countable

Magic methods summary

Properties summary

Since

Since