Class Zend_Db_Table_Rowset

Description

Implements interfaces:

  • Iterator (internal interface)

  • todo: also implement Countable if ZF minimum PHP version moves up to 5.1.
  • license: New BSD License
  • copyright: Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)

Located in /Zend/Db/Table/Rowset.php (line 38)


	
			
Variable Summary
 mixed $_count
 array $_data
 Zend_Db_Adapter $_db
 mixed $_pointer
 mixed $_rows
Method Summary
 Zend_Db_Table_Rowset __construct ([ $config = array()])
 int count ()
 mixed current ()
 bool exists ()
 int key ()
 int next ()
 void rewind ()
 array toArray ()
 bool valid ()
Variables
mixed $_count (line 69)

How many data rows there are.

  • access: protected
array $_data = array() (line 45)

The original data for each row.

  • access: protected
Zend_Db_Adapter $_db (line 52)

Zend_Db_Adapter object from the table interface.

  • access: protected
mixed $_pointer = 0 (line 64)

Iterator pointer.

  • access: protected
mixed $_rows = array() (line 75)

Collection of instantiated Zend_Db_Table_Row objects.

  • access: protected
Zend_Db_Table $_table (line 59)

Zend_Db_Table object.

  • access: protected
Methods
Constructor __construct (line 80)

Constructor.

  • access: public
Zend_Db_Table_Rowset __construct ([ $config = array()])
  • $config
count (line 166)

Returns the number of elements in the collection.

  • access: public
int count ()
current (line 107)

Return the current element.

Similar to the current() function for arrays in PHP

  • return: current element from the collection
  • access: public
mixed current ()

Implementation of:
Iterator::current
exists (line 176)

Returns true if $this->count > 0, false otherwise.

  • access: public
bool exists ()
key (line 134)

Return the identifying key of the current element.

Similar to the key() function for arrays in PHP.

  • access: public
int key ()

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

Move forward to next element.

Similar to the next() function for arrays in PHP.

  • return: The next pointer value.
  • access: public
int next ()

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

Rewind the Iterator to the first element.

Similar to the reset() function for arrays in PHP.

  • access: public
void rewind ()

Implementation of:
Iterator::rewind
toArray (line 188)

Returns all data as an array.

Updates the $_data property with current row object values.

  • access: public
array toArray ()
valid (line 156)

Check if there is a current element after calls to rewind() or next().

Used to check if we've iterated to the end of the collection.

  • return: False if there's nothing more to iterate over
  • access: public
bool valid ()

Implementation of:
Iterator::valid

Documentation generated on Thu, 18 Jan 2007 09:58:49 -0800 by phpDocumentor 1.3.1