Class cIterator

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
Todo: Add more stepping methods, as well as retrieving items
Located at classes/class.iterator.php

Methods summary
`public`	# `__construct( array $aItems )` Iterator constructor Iterator constructor 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( )` reset: Resets the iterator to the first element reset: Resets the iterator to the first element This function moves the iterator to the first element
`public mixed`	# `next( )` next: Returns the next item in the iterator next: 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 nothing was found
`public integer`	# `count( )` count: Returns the number of items in the iterator count: Returns the number of items in the iterator Returns `integer` Number of items

Properties summary
`public array`	`$_aIteratorItems`		# Holds the items which should be iterated Holds the items which should be iterated

Packages

Classes

Class cIterator

Parameters

Returns

Returns