Docs For Class xPDOIterator

xPDOIterator

Description

Implements interfaces:

Iterator (internal interface)

An iteratable representation of an xPDOObject result set.

Constants

Use an xPDOIterator to loop over large result sets and work with one instance at a time. This greatly reduces memory usage over loading the entire collection of objects into memory at one time. It is also slightly faster.

Located in /xpdo.class.php (line 2382)

Method Summary

xPDOIterator __construct (xPDO &$xpdo, [ $options = array()])

void current ()

void fetch ()

void key ()

void next ()

void rewind ()

void valid ()

Methods

Constructor __construct (line 2401)

Construct a new xPDOIterator instance (do not call directly).

Constants

return: An xPDOIterator instance.
see: xPDO::getIterator()

xPDOIterator __construct (xPDO &$xpdo, [ $options = array()])

xPDO &$xpdo: A reference to a valid xPDO instance.
array $options: An array of options for the iterator.

current (line 2439)

Constants

access: public

void current ()

Implementation of:

Iterator::current

fetch (line 2465)

Fetch the next row from the result set and set it as current.

Constants

Uses the loader defined for the specified class, so it does respect security.

access: protected

void fetch ()

key (line 2443)

Constants

access: public

void key ()

Implementation of:

Iterator::key

next (line 2447)

Constants

access: public

void next ()

Implementation of:

Iterator::next

rewind (line 2428)

Constants

access: public

void rewind ()

Implementation of:

Iterator::rewind

valid (line 2456)

Constants

access: public

void valid ()

Implementation of:

Iterator::valid

Documentation generated on Mon, 27 Dec 2010 11:08:27 -0700 by phpDocumentor 1.4.3