Class cIterator

A class which represents the C/C++/JAVA Iterator support.

Iterating items is a mechanism to "step" trough a list of defined items. Basically, the iterator is similar to an array, but provides easy functions to step trough the list.

An instance of an iterator is usually created by a class returning multiple items and automatically filled using the $aItems parameter of the constructor, and then returned to the caller.

The caller receives the iterator object and can step trough all items using the "next" method.

Package: Core\Util
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Unknown
Located at classes/class.iterator.php

Methods summary
`public`	# `__construct( array $aItems )` Constructor to create an instance of this class. Constructor to create an instance of this class. This function initializes the constructor, adds the passed items and moves the iterator to the first element. Parameters `$aItems` `array` $aItems Items to add
`public`	# `reset( )` Resets the iterator to the first element. Resets the iterator to the first element. This function moves the iterator to the first element
`public mixed`	# `next( )` Returns the next item in the iterator. Returns the next item in the iterator. This function returns the item, or false if no items are left. Returns `mixed` item or false if no items are left
`public integer`	# `count( )` Returns the number of items in the iterator. Returns the number of items in the iterator. Returns `integer` number of items

Properties summary
`protected array`	`$_aIteratorItems`		# Holds the items to iterate. Holds the items to iterate.
`protected array`	`$_keys`		# Holds the keys of the array which should be iterated Holds the keys of the array which should be iterated

Packages

Classes

Class cIterator

Parameters

Returns

Returns