Référence de la classe FOFDatabaseIterator

Graphe d'héritage de FOFDatabaseIterator:

Fonctions membres publiques
	__construct ($cursor, $column, $class, $config=array())
	__destruct ()
	current ()
	key ()
	next ()
	rewind ()
	valid ()

Fonctions membres publiques statiques
static &	getIterator ($dbName, $cursor, $column, $class, $config=array())

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

Attributs protégés
	$cursor
	$class

Attributs privés
	$_column
	$_current
	$_currentTable
	$_key
	$_fetched = 0
	$_tableObject = null

Description détaillée

Database iterator

Documentation des constructeurs et destructeur

__construct()

__construct	(		$cursor,
			$column,
			$class,
			$config = array()
	)

Database iterator constructor.

Paramètres

mixed	$cursor	The database cursor.
string	$column	An option column to use as the iterator key.
string	$class	The table class of the returned objects.
array	$config	Configuration parameters to push to the table class

Exceptions

InvalidArgumentException

Références $class, $parts, FOFInflector\explode(), et FOFTable\getInstance().

__destruct()

__destruct

(

)

Database iterator destructor.

Documentation des fonctions membres

current()

current

(

)

The current element in the iterator.

Renvoie

object

Voir également

Iterator::current()

fetchObject()

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.

freeResult()

freeResult ( )

abstractprotected

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

Renvoie

void

getIterator()

static& getIterator (   $dbName,   $cursor,   $column,   $class,   $config = array()  )

static

Returns an iterator object for a specific database type

Paramètres

string	$dbName	The database type, e.g. mysql, mysqli, sqlazure etc.
mixed	$cursor	The database cursor
string	$column	An option column to use as the iterator key
string	$class	The table class of the returned objects
array	$config	Configuration parameters to push to the table class

Renvoie

FOFDatabaseIterator

Exceptions

InvalidArgumentException

Références $class, $className, et $config.

Référencé par FOFTableNested\get(), FOFModel\getIterator(), et FOFTableRelations\getIteratorFromRelation().

getTable()

getTable ( )

protected

Returns the data in $this->_current as a FOFTable instance

Renvoie

FOFTable

Exceptions

OutOfBoundsException

key()

key

(

)

The key of the current element in the iterator.

Renvoie

scalar

Voir également

Iterator::key()

next()

next

(

)

Moves forward to the next result from the SQL query.

Renvoie

void

Voir également

Iterator::next()

rewind()

rewind

(

)

Rewinds the iterator.

This iterator cannot be rewound.

Renvoie

void

Voir également

Iterator::rewind()

valid()

valid

(

)

Checks if the current position of the iterator is valid.

Renvoie

boolean

Voir également

Iterator::valid()

Documentation des champs

$_column

$_column

private

$_current

$_current

private

$_currentTable

$_currentTable

private

$_fetched

$_fetched = 0

private

$_key

$_key

private

$_tableObject

$_tableObject = null

private

$class

$class

protected

$cursor

$cursor

protected

---

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

• fof/database/iterator.php