Class Horde_Rdo_List

Description

Implements interfaces:

  • Iterator (internal interface)

Iterator for collections of Rdo objects.

  • TODO: implement ArrayAccess as well?

Located in /Rdo/lib/Horde/Rdo/List.php (line 15)


	
			
Variable Summary
Method Summary
 Horde_Rdo_List __construct (mixed $query, [Horde_Rdo_Mapper $mapper = null])
 void __destruct ()
 mixed current ()
 mixed key ()
 void rewind ()
 boolean valid ()
Variables
array $_bindParams = array() (line 33)

Bind parameters

  • access: protected
Horde_Rdo_Base $_current (line 45)

Current object

  • access: protected
boolean $_eof (line 57)

Are we at the end of the list?

  • access: protected
integer $_index (line 51)

Current list offset.

  • access: protected
Horde_Rdo_Mapper $_mapper (line 21)

Rdo Mapper

  • access: protected
Iterator $_result (line 39)

Result resource

  • access: protected
string $_sql (line 27)

SQL query to run

  • access: protected
Methods
Constructor __construct (line 68)

Constructor.

  • access: public
Horde_Rdo_List __construct (mixed $query, [Horde_Rdo_Mapper $mapper = null])
  • mixed $query: The query to run when results are requested. Can be a Horde_Rdo_Query object, a literal SQL query, or a tuple containing an SQL string and an array of bind parameters to use.
  • Horde_Rdo_Mapper $mapper: Mapper to create objects for this list from.
Destructor __destruct (line 99)

Destructor - release any resources.

  • access: public
void __destruct ()
current (line 127)

Implementation of the current() method for iterator.

  • return: The current row, or null if no rows.
  • access: public
mixed current ()

Implementation of:
Iterator::current
key (line 140)

Implementation of the key() method for iterator.

  • return: The current row number (starts at 0), or NULL if no rows
  • access: public
mixed key ()

Implementation of:
Iterator::key
next (line 154)

Implementation of the next() method.

  • return: The next Rdo object in the set or null if no more results.
  • access: public
Horde_Rdo_Base|null next ()

Implementation of:
Iterator::next
rewind (line 109)

Implementation of the rewind() method for iterator.

  • access: public
void rewind ()

Implementation of:
Iterator::rewind
valid (line 185)

Implementation of the valid() method for iterator

  • return: Whether the iteration is valid
  • access: public
boolean valid ()

Implementation of:
Iterator::valid

Documentation generated on Sun, 30 Jan 2011 05:19:14 +0000 by phpDocumentor 1.4.3