Class Iterator

Iterator for character sets. Use Charset::iterator() to retrieve a character set iterator instance.

Core\Object implements Core\Chainable

Core\Charset\Iterator implements Iterator

Namespace: Core\Charset
Package: Core\Charset
See: Charset::iterator()
Since: 3.0
Requires: PHP 5.3
Version: 1.0.1
Located at Charset.inc.php

Methods summary

`public`	# `__construct( array $charSets )` Parameters `$charSets` Array of character set names to iterate over. Instances are fetched during iteration, thus are lazily created. Multiple iterations are safe as instances are cached by the `Core\Charset` class itself. Since 3.0
`public Core\Charset`	# `current( )` Returns the current `Core\Charset` instance (used by iterators). Returns the current `Core\Charset` instance (used by iterators). Returns `Core\Charset` Reference to character set instance or `null`, if the current position does not refer to a valid character set. Since 3.0 Implementation of `Iterator::current()`
`public integer`	# `key( )` Returns the current iteration index (used by iterators). Returns the current iteration index (used by iterators). Returns integer Current zero-based iteration index. Since 3.0 Implementation of `Iterator::key()`
`public`	# `next( )` Increases the internal iteration index by one (used by iterators). Increases the internal iteration index by one (used by iterators). Since 3.0 Implementation of `Iterator::next()`
`public`	# `rewind( )` Resets the internal iteration index to `0` (used by iterators). Resets the internal iteration index to `0` (used by iterators). Since 3.0 Implementation of `Iterator::rewind()`
`public boolean`	# `valid( )` Tests, whether the current iteration index is valid (used by iterators). Tests, whether the current iteration index is valid (used by iterators). Returns boolean `true`, if the current index is within range, otherwise `false`. Since 3.0 Implementation of `Iterator::valid()`

Methods inherited from Core\Object

__autocreateFactory(), __call(), __processParameters(), __toString(), attachMethod(), chain(), getValueForKey(), getValueForKeyPath(), getValueForUndefinedKey(), hash(), issetValueForKey(), setValueForKey(), setValueForKeyPath(), setValueForUndefinedKey(), uuid()

Constants summary

Constants inherited from Core\Object

AnyParameterType, AutochainParameterType, AutocreateParameterType, BooleanParameterType, CharParameterType, EnumParameterType, IntegerParameterType, RealParameterType, StringParameterType, UserParameterType

Properties summary

`protected string[]`	`$_charSets` Array of character set names to iterate over. Array of character set names to iterate over. Since 3.0	#
`protected integer`	`$_position` Current position in character set name array. Current position in character set name array. Since 3.0	#

Magic properties inherited from Core\Object

$hash, $uuid

Namespaces

Classes

Class Iterator

Methods summary

Parameters

Since

Returns

Since

Implementation of

Returns

Since

Implementation of

Since

Implementation of

Since

Implementation of

Returns

Since

Implementation of

Methods inherited from Core\Object

Constants summary

Constants inherited from Core\Object

Properties summary

Since

Since

Magic properties inherited from Core\Object