The IntlIterator class

(PHP 5 >= 5.5.0, PHP 7)

Introduction

This class represents iterator objects throughout the intl extension whenever the iterator cannot be identified with any other object provided by the extension. The distinct iterator object used internally by the foreach construct can only be obtained (in the relevant part here) from objects, so objects of this class serve the purpose of providing the hook through which this internal object can be obtained. As a convenience, this class also implements the Iterator interface, allowing the collection of values to be navigated using the methods defined in that interface. Both these methods and the internal iterator objects provided to foreach are backed by the same state (e.g. the position of the iterator and its current value).

Subclasses may provide richer functionality.

Class synopsis

IntlIterator implements Iterator {

/* Methods */

public current ( void ) : mixed

public key ( void ) : string

public next ( void ) : void

public rewind ( void ) : void

public valid ( void ) : bool

}

IntlIterator::current — Get the current element
IntlIterator::key — Get the current key
IntlIterator::next — Move forward to the next element
IntlIterator::rewind — Rewind the iterator to the first element
IntlIterator::valid — Check if current position is valid

The IntlIterator class

Introduction

Class synopsis

Table of Contents