Class Locale_Iterator

Iterator for locales. Use Locale::iterator() to retrieve a locale iterator instance.

Core\Object implements Core\Chainable

Core\Locale_Iterator implements Iterator

Namespace: Core
Package: Core\Locale
See: Locale::iterator()
Since: 3.0
Since: PHP 5.3
Version: 1.0
Located at Locale.inc.php

Methods summary

`public`	# `__construct( array $locales )` Initialises a locale iterator. Initialises a locale iterator. Parameters `$locales` Array of locale names to iterate over. Since 3.0
`public Core\Locale`	# `current( )` Returns the current `Core\Locale` instance (used by iterators). Returns the current `Core\Locale` instance (used by iterators). Returns `Core\Locale` Reference to locale instance or `null`, if the currently iterated locale names entry is an invalid locale name. 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[]`	`$_locales` Array of locales to iterate over. Array of locales to iterate over. Since 3.0	#
`protected integer`	`$_position` Current iteration position. Current iteration position. Since 3.0	#

Magic properties inherited from Core\Object

$hash, $uuid

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class Locale_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