Namespaces

Composer
- Autoload
Joomla
- Application
  - Cli
    - Output
      - Processor
  - Web
- Data
- DI
  - Exception
- Event
- Filter
- Input
- Ldap
- Registry
  - Format
- Session
  - Storage
- String
- Uri
- Utilities
None
PasswordCompat
- binary
PHP
Psr
- Log
Symfony
- Component
  - Yaml
    - Exception
- Polyfill
  - Util

Classes

Interfaces

Exceptions

Constants

Functions

Class FOFDatabaseIterator

Database iterator

FOFDatabaseIterator implements Iterator

Direct known subclasses

FOFDatabaseIteratorMysql, FOFDatabaseIteratorMysqli, FOFDatabaseIteratorPdo, FOFDatabaseIteratorPostgresql, FOFDatabaseIteratorSqlsrv

Indirect known subclasses

FOFDatabaseIteratorAzure, FOFDatabaseIteratorOracle, FOFDatabaseIteratorPdomysql, FOFDatabaseIteratorSqlite

Abstract
Package: FrameworkOnFramework\database
Copyright: Copyright (C) 2010-2016 Nicholas K. Dionysopoulos / Akeeba Ltd. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt This file is adapted from the Joomla! Platform. It is used to iterate a database cursor returning FOFTable objects instead of plain stdClass objects
Located at fof/database/iterator.php

Methods summary

`public static FOFDatabaseIterator &`	# `getIterator( string $dbName, mixed $cursor, string $column = null, string $class, array $config = array() )` Returns an iterator object for a specific database type Returns an iterator object for a specific database type Parameters `$dbName` `string` - $dbName The database type, e.g. mysql, mysqli, sqlazure etc. `$cursor` `mixed` - $cursor The database cursor `$column` `string` - $column An option column to use as the iterator key `$class` `string` - $class The table class of the returned objects `$config` `array` - $config Configuration parameters to push to the table class Returns `FOFDatabaseIterator` Throws `InvalidArgumentException`
`public`	# `__construct( mixed $cursor, string $column = null, string $class, array $config = array() )` 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 table class of the returned objects. `$config` `array` - $config Configuration parameters to push to the table class Throws `InvalidArgumentException`
`public`	# `__destruct( )` Database iterator destructor. Database iterator destructor.
`public object`	# `current( )` The current element in the iterator. The current element in the iterator. Returns `object` 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` 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. See `Iterator::next()` Implementation of `Iterator::next()`
`public`	# `rewind( )` Rewinds the iterator. Rewinds the iterator. This iterator cannot be rewound. 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` 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.
`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.
`protected FOFTable`	# `getTable( )` Returns the data in $this->_current as a FOFTable instance Returns the data in $this->_current as a FOFTable instance Returns `FOFTable` Throws `OutOfBoundsException`

Magic methods summary

Properties summary

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