Référence de la classe JDatabaseIterator

Graphe d'héritage de JDatabaseIterator:

Liste de tous les membres

Fonctions membres publiques
	__construct ($cursor, $column=null, $class= 'stdClass')
	__destruct ()
	current ()
	key ()
	next ()
	rewind ()
	valid ()

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

Attributs protégés
	$cursor
	$class

Attributs privés
	$_column
	$_current
	$_key
	$_fetched = 0

---

Description détaillée

Définition à la ligne 19 du fichier iterator.php.

---

Documentation des constructeurs et destructeur

JDatabaseIterator::__construct	(		$cursor,
			$column = null,
			$class = 'stdClass'
	)

Database iterator constructor.

Paramètres:

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

Définition à la ligne 78 du fichier iterator.php.

        {
                if (!class_exists($class))
                {
                        throw new InvalidArgumentException(sprintf('new %s(*%s*, cursor)', get_class($this), gettype($class)));
                }

                $this->cursor = $cursor;
                $this->class = $class;
                $this->_column = $column;
                $this->_fetched = 0;
                $this->next();
        }

JDatabaseIterator::__destruct

(

)

Database iterator destructor.

Depuis:

12.1

Définition à la ligne 97 du fichier iterator.php.

        {
                if ($this->cursor)
                {
                        $this->freeResult($this->cursor);
                }
        }

---

Documentation des fonctions membres

JDatabaseIterator::current

(

)

The current element in the iterator.

Renvoie:

object

Voir également:

Iterator::current()

Depuis:

12.1

Définition à la ligne 113 du fichier iterator.php.

        {
                return $this->_current;
        }

JDatabaseIterator::fetchObject ( )

abstractprotected

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:

12.1

Réimplémentée dans JDatabaseIteratorPdo, JDatabaseIteratorMysql, JDatabaseIteratorMysqli, JDatabaseIteratorPostgresql, et JDatabaseIteratorSqlsrv.

Référencé par JDatabaseIteratorPdo\fetchObject().

Voici le graphe des appelants de cette fonction :

JDatabaseIterator::freeResult ( )

abstractprotected

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

Renvoie:

void

Depuis:

12.1

Réimplémentée dans JDatabaseIteratorPdo, JDatabaseIteratorMysql, JDatabaseIteratorMysqli, JDatabaseIteratorPostgresql, et JDatabaseIteratorSqlsrv.

JDatabaseIterator::key

(

)

The key of the current element in the iterator.

Renvoie:

scalar

Voir également:

Iterator::key()

Depuis:

12.1

Définition à la ligne 126 du fichier iterator.php.

        {
                return $this->_key;
        }

JDatabaseIterator::next

(

)

Moves forward to the next result from the SQL query.

Renvoie:

void

Voir également:

Iterator::next()

Depuis:

12.1

Définition à la ligne 139 du fichier iterator.php.

        {
                // Set the default key as being the number of fetched object
                $this->_key = $this->_fetched;

                // Try to get an object
                $this->_current = $this->fetchObject();

                // If an object has been found
                if ($this->_current)
                {
                        // Set the key as being the indexed column (if it exists)
                        if (isset($this->_current->{$this->_column}))
                        {
                                $this->_key = $this->_current->{$this->_column};
                        }

                        // Update the number of fetched object
                        $this->_fetched++;
                }
        }

JDatabaseIterator::rewind

(

)

Rewinds the iterator.

This iterator cannot be rewound.

Renvoie:

void

Voir également:

Iterator::rewind()

Depuis:

12.1

Définition à la ligne 171 du fichier iterator.php.

        {
        }

JDatabaseIterator::valid

(

)

Checks if the current position of the iterator is valid.

Renvoie:

boolean

Voir également:

Iterator::valid()

Depuis:

12.1

Définition à la ligne 183 du fichier iterator.php.

        {
                return (boolean) $this->_current;
        }

---

Documentation des données membres

JDatabaseIterator::$_column

private

Définition à la ligne 43 du fichier iterator.php.

JDatabaseIterator::$_current

private

Définition à la ligne 51 du fichier iterator.php.

JDatabaseIterator::$_fetched = 0

private

Définition à la ligne 67 du fichier iterator.php.

JDatabaseIterator::$_key

private

Définition à la ligne 59 du fichier iterator.php.

JDatabaseIterator::$class

protected

Définition à la ligne 35 du fichier iterator.php.

JDatabaseIterator::$cursor

protected

Définition à la ligne 27 du fichier iterator.php.

---

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

• jplatform-13.1/joomla/database/iterator.php