Référence de la classe DatabaseIterator

Graphe d'héritage de DatabaseIterator:

Fonctions membres publiques
	__construct (StatementInterface $statement, $column=null, $class=\stdClass::class)
	__destruct ()
	count ()
	current ()
	key ()
	next ()
	rewind ()
	valid ()

Fonctions membres protégées
	fetchObject ()
	freeResult ()

Attributs protégés
	$class
	$statement

Attributs privés
	$column
	$current
	$key
	$fetched = 0

Description détaillée

Joomla Framework Database Driver Class

Depuis

1.0

Documentation des constructeurs et destructeur

__construct()

__construct	(	StatementInterface	$statement,
			$column = null,
			$class = \stdClass::class
	)

Database iterator constructor.

Paramètres

StatementInterface	$statement	The statement holding the result set to iterate.
string	$column	An option column to use as the iterator key.
string	$class	The class of object that is returned.

Depuis

1.0

Exceptions

Références DatabaseIterator\$class, DatabaseIterator\$column, DatabaseIterator\$statement, $this, class, FetchMode\CUSTOM_OBJECT, DatabaseIterator\next(), et FetchMode\STANDARD_OBJECT.

__destruct()

__destruct

(

)

Database iterator destructor.

Depuis

1.0

Références DatabaseIterator\freeResult().

Documentation des fonctions membres

count()

count

(

)

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

Renvoie

integer The number of rows in the result set.

Voir également

Countable::count()

Depuis

1.0

current()

current

(

)

The current element in the iterator.

Renvoie

object

Voir également

Iterator::current()

Depuis

1.0

Références DatabaseIterator\$current.

fetchObject()

fetchObject ( )

protected

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

Renvoie

mixed Either the next row from the result set or false if there are no more rows.

Depuis

1.0

Référencé par DatabaseIterator\next().

freeResult()

freeResult ( )

protected

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

Renvoie

void

Depuis

1.0

Référencé par DatabaseIterator\__destruct().

key()

key

(

)

The key of the current element in the iterator.

Renvoie

scalar

Voir également

Iterator::key()

Depuis

1.0

Références DatabaseIterator\$key.

Référencé par DatabaseIterator\next().

next()

next

(

)

Moves forward to the next result from the SQL query.

Renvoie

void

Voir également

Iterator::next()

Depuis

1.0

Références DatabaseIterator\$fetched, $this, DatabaseIterator\fetchObject(), et DatabaseIterator\key().

Référencé par DatabaseIterator\__construct().

rewind()

rewind

(

)

Rewinds the iterator.

This iterator cannot be rewound.

Renvoie

void

Voir également

Iterator::rewind()

Depuis

1.0

valid()

valid

(

)

Checks if the current position of the iterator is valid.

Renvoie

boolean

Voir également

Iterator::valid()

Depuis

1.0

Documentation des champs

$class

$class

protected

Référencé par DatabaseIterator\__construct().

$column

$column

private

Référencé par DatabaseIterator\__construct().

$current

$current

private

Référencé par DatabaseIterator\current().

$fetched

$fetched = 0

private

Référencé par DatabaseIterator\next().

$key

$key

private

Référencé par DatabaseIterator\key().

$statement

$statement

protected

Référencé par DatabaseIterator\__construct().

---

La documentation de cette classe a été générée à partir du fichier suivant :

• DatabaseIterator.php