Main Page | Namespace List | Class Hierarchy | Class List | File List | Class Members | File Members | Related Pages

ArrayIterator Class Reference

Inheritance diagram for ArrayIterator:

Inheritance graph
[legend]
Collaboration diagram for ArrayIterator:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ArrayIterator (&$oarray)
 __construct (&$oarray)
 reset ()
next ()
 isValid ()
 index ()
value ()
 remove ()

Public Attributes

 $_src
 $_values
 $_value
 $_i

Detailed Description

OArray itertor class.

This kind of iterators are used to walk throug a OArray object.

Author:
Laurent Bedubourg <laurent.bedubourg@free.fr>

Definition at line 300 of file OArray.php.


Constructor & Destructor Documentation

ArrayIterator::ArrayIterator &$  oarray  ) 
 

Iterator constructor.

Parameters:
mixed $oarray OArray object or php array.

Definition at line 312 of file OArray.php.


Member Function Documentation

ArrayIterator::__construct &$  oarray  ) 
 

PHP 4.4 compliant constructor.

Parameters:
mixed $oarray OArray object or php array.

Definition at line 322 of file OArray.php.

References PEAR_ERROR_DIE, and reset().

ArrayIterator::index  ) 
 

Retrieve current iterator index.

Returns:
int

Reimplemented from Iterator.

Definition at line 385 of file OArray.php.

ArrayIterator::isValid  ) 
 

Test if the iteractor has not reached its end.

Returns:
boolean

Reimplemented from Iterator.

Definition at line 376 of file OArray.php.

& ArrayIterator::next  ) 
 

Returns next vector item value.

Returns:
mixed
Exceptions:
OutOfBounds if iterator overpass the vector size.

Reimplemented from Iterator.

Definition at line 361 of file OArray.php.

ArrayIterator::remove  ) 
 

Delete current index.

Reimplemented from Iterator.

Definition at line 402 of file OArray.php.

ArrayIterator::reset  ) 
 

Reset iterator to first array position.

Reimplemented from Iterator.

Definition at line 342 of file OArray.php.

Referenced by __construct().

& ArrayIterator::value  ) 
 

Retrieve the current iterator value.

Returns:
mixed

Reimplemented from Iterator.

Definition at line 394 of file OArray.php.


Member Data Documentation

ArrayIterator::$_i
 

Definition at line 305 of file OArray.php.

ArrayIterator::$_src
 

Definition at line 302 of file OArray.php.

ArrayIterator::$_value
 

Definition at line 304 of file OArray.php.

ArrayIterator::$_values
 

Definition at line 303 of file OArray.php.


The documentation for this class was generated from the following file:
Generated on Tue Jun 29 23:40:19 2004 for Mediawiki by doxygen 1.3.7