OracleIterator

Extends \Joomla\Database\Pdo\PdoIterator

Oracle Database Iterator.

deprecated
since

1.0

deprecated

2.0 Oracle support will be removed.

Methods

__construct

Database iterator constructor.

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

1.0

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() 
inherited
since

1.0

count

Get the number of rows in the result set for the executed SQL given by the cursor.

count() : integer
inherited abstract
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
inherited
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
inherited abstract
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
inherited abstract
since

1.0

key

The key of the current element in the iterator.

key() : scalar
inherited
see \Joomla\Database\Iterator::key()
since

1.0

Response

scalar

next

Moves forward to the next result from the SQL query.

next() : void
inherited
see \Joomla\Database\Iterator::next()
since

1.0

rewind

Rewinds the iterator.

rewind() : void
inherited

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
inherited
see \Joomla\Database\Iterator::valid()
since

1.0

Response

boolean

Properties

cursor

The database cursor.

inherited
since

1.0

Type(s)

mixed

class

The class of object to create.

inherited
since

1.0

Type(s)

string

column

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

inherited
since

1.0

Type(s)

mixed

current

The current database record.

inherited
since

1.0

Type(s)

mixed

key

A numeric or string key for the current database record.

inherited
since

1.0

Type(s)

scalar

fetched

The number of fetched records.

inherited
since

1.0

Type(s)

integer