CMapIterator
| Package | system.collections |
|---|---|
| Inheritance | class CMapIterator |
| Implements | Iterator, Traversable |
| Since | 1.0 |
| Version | $Id: CMapIterator.php 1678 2010-01-07 21:02:00Z qiang.xue $ |
CMapIterator implements an interator for CMap.
It allows CMap to return a new iterator for traversing the items in the map.
It allows CMap to return a new iterator for traversing the items in the map.
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __construct() | Constructor. | CMapIterator |
| current() | Returns the current array element. | CMapIterator |
| key() | Returns the key of the current array element. | CMapIterator |
| next() | Moves the internal pointer to the next array element. | CMapIterator |
| rewind() | Rewinds internal array pointer. | CMapIterator |
| valid() | Returns whether there is an element at current position. | CMapIterator |
Method Details
__construct()
method
|
public void __construct(array $data)
| ||
| $data | array | the data to be iterated through |
Constructor.
current()
method
|
public mixed current()
| ||
| {return} | mixed | the current array element |
Returns the current array element. This method is required by the interface Iterator.
key()
method
|
public mixed key()
| ||
| {return} | mixed | the key of the current array element |
Returns the key of the current array element. This method is required by the interface Iterator.
next()
method
|
public void next()
|
Moves the internal pointer to the next array element. This method is required by the interface Iterator.
rewind()
method
|
public void rewind()
|
Rewinds internal array pointer. This method is required by the interface Iterator.
valid()
method
|
public boolean valid()
| ||
| {return} | boolean | |
Returns whether there is an element at current position. This method is required by the interface Iterator.